Struct SpxBuilder

Source
pub struct SpxBuilder<W> { /* private fields */ }
Expand description

Compile-time [FileMap] builder

Implementations§

Source§

impl<W: Write + Seek> SpxBuilder<W>

Source

pub fn new(writer: W) -> Self

Create new builder

Examples found in repository?
examples/archive.rs (line 13)
11fn main() -> Result<(), Box<dyn Error>> {
12    let mut data = Vec::new();
13    let mut builder = SpxBuilder::new(Cursor::new(&mut data));
14
15    builder.write_stream("hello world.txt".into(), Cursor::new(&"Hello world!"))?;
16    builder.write_stream("example".into(), Cursor::new(&"asdf"))?;
17
18    println!("map: {}", builder.build());
19    println!("archive: {:?}", data);
20
21    Ok(())
22}
Source

pub fn start_file(&mut self, name: String) -> Result<SpxFileEntry<'_, W>>

Start new file entry

Source

pub fn build(&self) -> Display<'_>

Generate and return [FileMap] code

Examples found in repository?
examples/archive.rs (line 18)
11fn main() -> Result<(), Box<dyn Error>> {
12    let mut data = Vec::new();
13    let mut builder = SpxBuilder::new(Cursor::new(&mut data));
14
15    builder.write_stream("hello world.txt".into(), Cursor::new(&"Hello world!"))?;
16    builder.write_stream("example".into(), Cursor::new(&"asdf"))?;
17
18    println!("map: {}", builder.build());
19    println!("archive: {:?}", data);
20
21    Ok(())
22}

Trait Implementations§

Source§

impl<W: Debug> Debug for SpxBuilder<W>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<W: Write + Seek> FileExt<W> for SpxBuilder<W>

Source§

fn write_dir(&mut self, base: impl AsRef<Path>) -> Result<u64>

Write every disk files from base directory
Source§

impl<W: Write + Seek> StreamExt<W> for SpxBuilder<W>

Source§

fn write_stream(&mut self, name: String, stream: impl Read) -> Result<u64>

Write a file entry from Read stream

Auto Trait Implementations§

§

impl<W> Freeze for SpxBuilder<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for SpxBuilder<W>
where W: RefUnwindSafe,

§

impl<W> Send for SpxBuilder<W>
where W: Send,

§

impl<W> Sync for SpxBuilder<W>
where W: Sync,

§

impl<W> Unpin for SpxBuilder<W>
where W: Unpin,

§

impl<W> UnwindSafe for SpxBuilder<W>
where W: UnwindSafe,

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> 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> Same for T

Source§

type Output = T

Should always be Self
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.