Struct libimagstore::store::Entry

pub struct Entry { /* fields omitted */ }

An Entry of the store Contains location, header and content part.

Methods

impl Entry

pub fn new(loc: StoreId) -> Entry

Create a new store entry with its location at loc.

This creates the entry with the default header from Entry::default_header() and an empty content.

pub fn default_header() -> Value

Get the default Header for an Entry.

This function should be used to get a new Header, as the default header may change. Via this function, compatibility is ensured.

pub fn from_reader<S: IntoStoreId>(loc: S, file: &mut dyn Read) -> Result<Entry>

See Entry::from_str(), as this function is used internally. This is just a wrapper for convenience.

pub fn from_str<S: IntoStoreId>(loc: S, s: &str) -> Result<Entry>

Create a new Entry, with contents from the string passed.

The passed string must be a complete valid store entry, including header. So this is probably not what end-users want to call.

Return value

This errors if

• String cannot be matched on regex to find header and content
• Header cannot be parsed into a TOML object

pub fn to_str(&self) -> Result<String>

Return the string representation of this entry

This means not only the content of the entry, but the complete entry (from memory, not from disk).

pub fn get_location(&self) -> &StoreId

Get the location of the Entry

pub fn get_header(&self) -> &Value

Get the header of the Entry

pub fn get_header_mut(&mut self) -> &mut Value

Get the header mutably of the Entry

pub fn get_content(&self) -> &EntryContent

Get the content of the Entry

pub fn set_content(&mut self, content: EntryContent)

Set the content of the Entry

pub fn get_content_mut(&mut self) -> &mut EntryContent

Get the content mutably of the Entry

pub fn replace_from_buffer(&mut self, buf: &str) -> Result<()>

Replace both header and content of the entry by reading from buffer

If an error is returned, the contents of neither the header nor the content are modified.

pub fn verify(&self) -> Result<()>

Verify the entry.

Currently, this only verifies the header. This might change in the future.

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl PartialEq<Entry> for Entry

fn eq(&self, other: &Entry) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.