Rename StoreResult to PushResult.

Update documentation examples

Signed-off-by: Tin Svagelj <[email protected]>

src/details.rs

@@ -109,7 +109,7 @@ pub trait StorageDetails: ImplBase {
     type SizeType;
 
     /// The type representing result of storing data.
-    type StoreResult<T>;
+    type PushResult<T>;
 
     /// Builds a new internal state from provided parameters
     fn build_state(
@@ -167,7 +167,7 @@ impl StorageDetails for ImplConcurrent {
     type Base = RwLock<*mut u8>;
     type AllocationTracker = Mutex<AllocationTracker>;
     type SizeType = AtomicUsize;
-    type StoreResult<T> = Result<Self::ReferenceType<T>, LockingError>;
+    type PushResult<T> = Result<Self::ReferenceType<T>, LockingError>;
 
     fn build_state(
         base: *mut u8,
@@ -261,7 +261,7 @@ impl StorageDetails for ImplDefault {
     type Base = Cell<*mut u8>;
     type AllocationTracker = RefCell<AllocationTracker>;
     type SizeType = Cell<usize>;
-    type StoreResult<T> = ContiguousEntryRef<T>;
+    type PushResult<T> = ContiguousEntryRef<T>;
 
     fn build_state(
         base: *mut u8,
@@ -354,7 +354,7 @@ impl StorageDetails for ImplUnsafe {
     type Base = *mut u8;
     type AllocationTracker = AllocationTracker;
     type SizeType = usize;
-    type StoreResult<T> = Result<*mut T, ContiguousMemoryError>;
+    type PushResult<T> = Result<*mut T, ContiguousMemoryError>;
 
     fn build_state(
         base: *mut u8,
@@ -576,7 +576,7 @@ pub trait StoreDataDetails: StorageDetails {
         state: &mut Self::StorageState,
         data: *mut T,
         layout: Layout,
-    ) -> Self::StoreResult<T>;
+    ) -> Self::PushResult<T>;
 
     fn assume_stored<T: StoreRequirements>(
         state: &Self::StorageState,

src/lib.rs

@@ -184,15 +184,15 @@ impl<Impl: ImplDetails> ContiguousMemoryStorage<Impl> {
     /// let mut storage = UnsafeContiguousMemory::new(0);
     /// let value = [2, 4, 8, 16];
     ///
-    /// # assert_eq!(storage.can_store(&value).unwrap(), false);
-    /// if !storage.can_store(&value).unwrap() {
+    /// # assert_eq!(storage.can_push(&value).unwrap(), false);
+    /// if !storage.can_push(&value).unwrap() {
     ///     storage.resize(storage.get_capacity() + size_of_val(&value));
     ///
     ///     // ...update old pointers...
     /// }
     ///
     /// let stored_value =
-    ///   storage.store(value).expect("unable to store after growing the container");
+    ///   storage.push(value).expect("unable to store after growing the container");
     /// ```
     ///
     /// # Errors
@@ -240,7 +240,7 @@ impl<Impl: ImplDetails> ContiguousMemoryStorage<Impl> {
     /// Memory block can still be grown by calling [`ContiguousMemory::resize`],
     /// but it can't be done automatically as that would invalidate all the
     /// existing pointers without any indication.
-    pub fn push<T: StoreRequirements>(&mut self, value: T) -> Impl::StoreResult<T> {
+    pub fn push<T: StoreRequirements>(&mut self, value: T) -> Impl::PushResult<T> {
         let mut data = ManuallyDrop::new(value);
         let layout = Layout::for_value(&data);
         let pos = &mut *data as *mut T;
@@ -259,7 +259,7 @@ impl<Impl: ImplDetails> ContiguousMemoryStorage<Impl> {
         &mut self,
         data: *mut T,
         layout: Layout,
-    ) -> Impl::StoreResult<T> {
+    ) -> Impl::PushResult<T> {
         Impl::push_raw(&mut self.inner, data, layout)
     }
 
@@ -275,7 +275,7 @@ impl<Impl: ImplDetails> ContiguousMemoryStorage<Impl> {
     /// ```rust
     /// # use contiguous_mem::UnsafeContiguousMemory;
     /// let mut storage = UnsafeContiguousMemory::new(128);
-    /// let initial_position = storage.store(278u32).unwrap();
+    /// let initial_position = storage.push(278u32).unwrap();
     ///
     /// // ...other code...
     ///