Skip to main content

ImageEditor

Struct ImageEditor 

Source
pub struct ImageEditor { /* private fields */ }
Expand description

Explicit full-image editor for already materialized littlefs images.

This is an offline/host-side utility. Mounted APIs must not call it as a hidden fallback because it owns a complete image Vec.

Implementations§

Source§

impl ImageEditor

Source

pub fn open(image: Vec<u8>, cfg: Config) -> Result<Self>

Source

pub fn used_blocks(&self) -> &[bool]

Source

pub fn create_file(&mut self, path: &str, data: &[u8]) -> Result<&mut Self>

Creates a new file in an imported image.

The editor appends a normal littlefs CREATE/name/struct commit to the target metadata pair, choosing the create id by lexical order so later entries shift as they would in a directory log written by C. Small files are stored inline; larger files allocate CTZ blocks from the scanned reachable-block map and erase them before programming.

Source

pub fn create_dir(&mut self, path: &str) -> Result<&mut Self>

Creates a new root-level directory in an imported image.

The directory receives a freshly allocated metadata pair containing a valid empty commit, then the root pair gets a CREATE/name/DIRSTRUCT commit that makes the child reachable. This mirrors the two pieces C needs to open the directory after remounting.

Source

pub fn update_inline_file( &mut self, path: &str, data: &[u8], ) -> Result<&mut Self>

Appends an inline struct update for an existing root-level file.

Imported-image editing starts with this narrow operation because it does not need new data blocks or parent DIRSTRUCT rewrites. The update is still a real littlefs metadata commit appended to the active root side, so upstream C must be able to mount the edited image and read the new bytes.

Source

pub fn update_file(&mut self, path: &str, data: &[u8]) -> Result<&mut Self>

Source

pub fn update_attr( &mut self, path: &str, attr_type: u8, data: &[u8], ) -> Result<&mut Self>

Source

pub fn delete_attr(&mut self, path: &str, attr_type: u8) -> Result<&mut Self>

Source

pub fn delete_file(&mut self, path: &str) -> Result<&mut Self>

Source

pub fn delete_dir(&mut self, path: &str) -> Result<&mut Self>

Source

pub fn into_bytes(self) -> Vec<u8>

Trait Implementations§

Source§

impl Clone for ImageEditor

Source§

fn clone(&self) -> ImageEditor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ImageEditor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.