[−][src]Struct libimagstore::store::Entry
An Entry of the store Contains location, header and content part.
Methods
impl Entry
[src]
pub fn new(loc: StoreId) -> Entry
[src]
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
[src]
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>
[src]
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>
[src]
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>
[src]
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
[src]
Get the location of the Entry
pub fn get_header(&self) -> &Value
[src]
Get the header of the Entry
pub fn get_header_mut(&mut self) -> &mut Value
[src]
Get the header mutably of the Entry
pub fn get_content(&self) -> &EntryContent
[src]
Get the content of the Entry
pub fn get_content_mut(&mut self) -> &mut EntryContent
[src]
Get the content mutably of the Entry
pub fn replace_from_buffer(&mut self, buf: &str) -> Result<()>
[src]
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<()>
[src]
Verify the entry.
Currently, this only verifies the header. This might change in the future.
Trait Implementations
impl PartialEq<Entry> for Entry
[src]
fn eq(&self, other: &Entry) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl Clone for Entry
[src]
fn clone(&self) -> Entry
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for Entry
[src]
Auto Trait Implementations
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,