Struct DynamicMemory 

pub struct DynamicMemory<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> { /* private fields */ }

Trait Implementations

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> Abandonable for DynamicMemory<Allocator, Shm>

unsafe fn abandon_in_place(this: NonNull<Self>)

Abandon a resource in place. Shall be used when a struct of multiple resources shall be abandoned and the resources cannot be moved out of the struct.

fn abandon(self)

impl<Allocator: Debug + ShmAllocator, Shm: Debug + SharedMemory<Allocator>> Debug for DynamicMemory<Allocator, Shm>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> NamedConcept for DynamicMemory<Allocator, Shm>

fn name(&self) -> &FileName

Returns the name of the concept

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> NamedConceptBuilder<DynamicMemory<Allocator, Shm>> for DynamicMemoryBuilder<Allocator, Shm>

where Shm::Builder: Debug,

fn new(name: &FileName) -> Self

Defines the name of the newly created NamedConcept.

fn config(self, config: &Shm::Configuration) -> Self

Sets the custom configuration of the concept.

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> NamedConceptBuilder<DynamicMemory<Allocator, Shm>> for DynamicViewBuilder<Allocator, Shm>

where Shm::Builder: Debug,

fn new(name: &FileName) -> Self

Defines the name of the newly created NamedConcept.

fn config(self, config: &Shm::Configuration) -> Self

Sets the custom configuration of the concept.

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> NamedConceptMgmt for DynamicMemory<Allocator, Shm>

where Shm::Builder: Debug,

type Configuration = <Shm as NamedConceptMgmt>::Configuration

unsafe fn remove_cfg( name: &FileName, config: &Shm::Configuration, ) -> Result<bool, NamedConceptRemoveError>

Removes an existing concept under a custom configuration. Returns true if the concepts existed and was removed, if the concept did not exist it returns false.

fn does_exist_cfg( name: &FileName, config: &Shm::Configuration, ) -> Result<bool, NamedConceptDoesExistError>

Returns true if a concept with that name exists under a custom configuration, otherwise false

fn list_cfg( config: &Shm::Configuration, ) -> Result<Vec<FileName>, NamedConceptListError>

Returns a list of all available concepts with a custom configuration.

fn remove_path_hint(value: &Path) -> Result<(), NamedConceptPathHintRemoveError>

Removes the path hint directory. Will be realized only when the concept actually uses the path hint.

unsafe fn remove(name: &FileName) -> Result<bool, NamedConceptRemoveError>

Removes an existing concept. Returns true if the concepts existed and was removed, if the concept did not exist it returns false.

fn does_exist(name: &FileName) -> Result<bool, NamedConceptDoesExistError>

Returns true if a concept with that name exists, otherwise false

fn list() -> Result<Vec<FileName>, NamedConceptListError>

Returns a list of all available concepts with the default configuration.

fn default_prefix() -> FileName

The default prefix of every zero copy connection

fn default_path_hint() -> Path

The default path hint for every zero copy connection

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> ResizableSharedMemory<Allocator, Shm> for DynamicMemory<Allocator, Shm>

where Shm::Builder: Debug,

type ViewBuilder = DynamicViewBuilder<Allocator, Shm>

Type alias to the ResizableSharedMemoryViewBuilder to open a ResizableSharedMemoryView to an existing ResizableSharedMemory.

type MemoryBuilder = DynamicMemoryBuilder<Allocator, Shm>

Type alias to the ResizableSharedMemoryBuilder to create a new ResizableSharedMemory.

type View = DynamicView<Allocator, Shm>

Type alias to the ResizableSharedMemoryView to open an existing ResizableSharedMemory as read-only.

fn max_number_of_reallocations() -> usize

Returns how many reallocations the ResizableSharedMemory supports. If the number is exceeded any call to ResizableSharedMemory::allocate() that requires a resize of the underlying SharedMemory segments will fail.

fn number_of_active_segments(&self) -> usize

Returns the number of active SharedMemory segments.

fn allocate( &self, layout: Layout, ) -> Result<ShmPointer, ResizableShmAllocationError>

Allocates a new piece of SharedMemory if the provided Layout exceeds the current supported Layout, the memory would be out-of-memory or the number of chunks exceeds the current supported amount of chunks, a new SharedMemory segment will be created. If this fails an SharedMemoryCreateError will be returned.

unsafe fn deallocate(&self, offset: PointerOffset, layout: Layout)

Release previously allocated memory

impl<Allocator, Shm: SharedMemory<Allocator>> ResizableSharedMemoryBuilder<Allocator, Shm, DynamicMemory<Allocator, Shm>> for DynamicMemoryBuilder<Allocator, Shm>

where Allocator: Debug + ShmAllocator, Shm::Builder: Debug,

fn max_chunk_layout_hint(self, value: Layout) -> Self

Provides an initial hint to the underlying ShmAllocator on how large the largest chunk will be. If the chunk exceeds the hinted Layout a new SharedMemory segment is acquired to satisfy the memory needs.

fn max_number_of_chunks_hint(self, value: usize) -> Self

Provides an initial hint to the underlying ShmAllocator on how many chunks at most will be used in parallel. If the number of chunk exceeds the hint a new SharedMemory segment is acquired to satisfy the memory needs.

fn allocation_strategy(self, value: AllocationStrategy) -> Self

Defines the AllocationStrategy that is pursued when a new SharedMemory segment is acquired.

fn create( self, ) -> Result<DynamicMemory<Allocator, Shm>, SharedMemoryCreateError>

Creates new SharedMemory. If it already exists the method will fail.

impl<Shm: SharedMemoryForPoolAllocator> ResizableSharedMemoryForPoolAllocator<Shm> for DynamicMemory<PoolAllocator, Shm>

where Shm::Builder: Debug,

unsafe fn deallocate_bucket(&self, offset: PointerOffset)

Release previously allocated memory

fn bucket_size(&self, segment_id: SegmentId) -> usize

Returns the bucket size of the corresponding PoolAllocator

impl<Allocator: ShmAllocator, Shm: SharedMemory<Allocator>> ResizableSharedMemoryViewBuilder<Allocator, Shm, DynamicMemory<Allocator, Shm>, DynamicView<Allocator, Shm>> for DynamicViewBuilder<Allocator, Shm>

where Shm::Builder: Debug,

fn timeout(self, value: Duration) -> Self

The timeout defines how long the SharedMemoryBuilder should wait for SharedMemoryBuilder::create() to finialize the initialization. This is required when the SharedMemory is created and initialized concurrently from another process. By default it is set to Duration::ZERO for no timeout.

fn open( self, access_mode: AccessMode, ) -> Result<DynamicView<Allocator, Shm>, SharedMemoryOpenError>

Opens already existing SharedMemory. If it does not exist or the initialization is not yet finished the method will fail.