Struct LiveFileStorageInfoEntry 

pub struct LiveFileStorageInfoEntry<'a> { /* private fields */ }

One file in a LiveFilesStorageInfo listing.

Every string accessor borrows straight out of the parent listing: the C API returns interior pointers into the std::strings it holds, so nothing is copied or freed here.

Implementations

impl<'a> LiveFileStorageInfoEntry<'a>

pub fn index(&self) -> usize

Position of this entry within the parent listing.

pub fn relative_filename(&self) -> &'a [u8]

The file name within its directory, for example 123456.sst.

pub fn relative_filename_lossy(&self) -> Cow<'a, str>

relative_filename as UTF-8, replacing invalid sequences.

pub fn directory(&self) -> &'a [u8]

The directory holding the file, without a trailing /. This could be a DB path, the WAL directory, and so on.

pub fn directory_lossy(&self) -> Cow<'a, str>

directory as UTF-8, replacing invalid sequences.

pub fn file_number(&self) -> u64

The file’s number within the DB, or 0 for files that have none, such as CURRENT.

pub fn file_type(&self) -> FileType

The role this file plays in the DB.

pub fn size(&self) -> u64

File size in bytes. See trim_to_size and replacement_contents for when the file on disk may differ.

pub fn trim_to_size(&self) -> bool

When true the file on disk may be longer than size and only the first size bytes belong in the copy. When false a length mismatch means the file is corrupt.

pub fn replacement_contents(&self) -> &'a [u8]

Contents to write instead of reading the file from disk, used for CURRENT. Empty means read the file on disk as usual; otherwise this is exactly size bytes long.

Unlike the other borrowed strings this may contain NUL bytes, so it comes from the length out-param rather than strlen.

pub fn file_checksum_func_name(&self) -> &'a [u8]

Name of the checksum function that produced this file’s checksum. Unknown when no checksum function is configured, empty when checksum info was not requested.

pub fn file_checksum_func_name_lossy(&self) -> Cow<'a, str>

file_checksum_func_name as UTF-8, replacing invalid sequences.

pub fn temperature(&self) -> Temperature

The storage tier the file is placed on.

Trait Implementations

impl<'a> Clone for LiveFileStorageInfoEntry<'a>

fn clone(&self) -> LiveFileStorageInfoEntry<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for LiveFileStorageInfoEntry<'a>

impl Debug for LiveFileStorageInfoEntry<'_>

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

Formats the value using the given formatter.