Struct imaged::DB

pub struct DB(_);

DB wraps the libimaged's Imaged type

Implementations

impl DB

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Open an imaged instance at the given path

pub fn destroy(self) -> Result<(), Error>

Destroy all imgd files at the DB's root

pub fn iter(&self) -> Result<Iter<'_>, Error>

Returns a new image iterator

pub fn iter_keys(&self) -> Result<KeyIter<'_>, Error>

Returns a new key iterator

pub fn get<S: AsRef<str>>(
    &self,
    key: S,
    editable: bool
) -> Result<Handle<'_>, Error>

Get a key, editable determines whether or not the pixels can be edited

pub fn is_locked(&self, key: &str) -> bool

Check if a key is in use

pub fn file_is_valid(&self, key: &str) -> bool

Check if a key is a valid imgd file

pub fn set<'a, S: AsRef<str>>(
    &'a self,
    key: S,
    image: &Image<'_>
) -> Result<Handle<'a>, Error>

Set a key

pub fn set_raw<S: AsRef<str>>(
    &self,
    key: S,
    meta: Meta,
    data: Option<*const c_void>
) -> Result<Handle<'_>, Error>

Set a key using metadata and a pointer to the image data

pub fn remove<S: AsRef<str>>(&self, key: S) -> Result<(), Error>

Remove a key

Trait Implementations

impl Drop for DB

fn drop(&mut self)

Executes the destructor for this type.