Skip to main content

Crate cu29_unifiedlog

Crate cu29_unifiedlog 

Source

Re-exports§

pub use noop::NoopLogger;
pub use noop::NoopSectionStorage;
pub use crate::memmap::LogPosition;
pub use crate::memmap::MmapUnifiedLogger as UnifiedLogger;
pub use crate::memmap::MmapUnifiedLoggerBuilder as UnifiedLoggerBuilder;
pub use crate::memmap::MmapUnifiedLoggerRead as UnifiedLoggerRead;
pub use crate::memmap::MmapUnifiedLoggerWrite as UnifiedLoggerWrite;
pub use crate::memmap::UnifiedLoggerIOReader;

Modules§

memmap
Mapped-file adapter for the byte-addressed section chain.
noop

Structs§

ApplicationMetadata
Static application identity and configuration, retained outside the data ring.
EndOfLogMarker
Payload stored in the end-of-log section to signal whether the log was cleanly closed.
LogStream
A wrapper around the unifiedlogger that implements the Write trait.
MainHeader
Header of the byte-addressed log. All offsets are relative to the log origin.
SectionContext
Construction identity shared by every section of an application instance.
SectionHandle
A SectionHandle is a handle to a section in the datalogger. It allows tracking the lifecycle of the section.
SectionHeader
One linked section. The allocation includes its 512-byte header reservation.
UnifiedLogStatus
Basic statistics for the unified logger. Note: the total_allocated_space might grow for the std implementation

Enums§

AllocatedSection
CapacityPolicy
Behavior when a section needs additional storage.

Constants§

MAIN_MAGIC
ID to spot the beginning of a Copper Log
SECTION_HEADER_COMPACT_SIZE
SECTION_MAGIC
ID to spot a section of Copper Log
UNIFIED_LOG_FORMAT_VERSION
Version of the unified log encapsulation only: file headers, section headers, and the layout used to locate sections in a slab.

Traits§

SectionStorage
A Storage is an append-only structure that can update a header section.
UnifiedLogRead
Read back a unified log linearly.
UnifiedLogWrite
The writing interface to the unified logger. Writing is “almost” linear as various streams can allocate sections and track them until they drop them.

Functions§

stream_write
Create a new stream to write to the unifiedlogger.