Struct txtar::Archive

source · [−]

pub struct Archive { /* private fields */ }

Expand description

An archive represents a tree of text files.

This type is used to read txtar files from disk and materialize the corresponding file layout.

Examples

use txtar::Archive;

let txt = "\
comment1
comment2
-- file1 --
File 1 text.
-- foo --
File 2 text.
-- empty --
-- noNL --
hello world";

let archive = Archive::from(txt);
archive.materialize("/tmp/somedir/").unwrap();

Implementations

impl Archive

pub fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

Serialize the archive as txtar into the I/O stream.

pub fn materialize<P: AsRef<Path>>(
&self,
path: P
) -> Result<(), MaterializeError>

Writes each file in this archive to the directory at the given path.

Errors

This function will error in the event a file would be written outside of the directory or if an existing file would be overwritten. Additionally, any errors caused by the underlying I/O operations will be propagated.

Trait Implementations

impl Debug for Archive

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

Formats the value using the given formatter. Read more

impl Default for Archive

fn default() -> Archive

Returns the “default value” for a type. Read more

impl Display for Archive

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

Formats the value using the given formatter. Read more

impl From<&'_ str> for Archive

fn from(s: &str) -> Archive

Converts to this type from the input type.

impl PartialEq<Archive> for Archive

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

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

fn ne(&self, other: &Archive) -> bool

This method tests for !=.

impl TryFrom<&'_ [u8 ]> for Archive

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(slice: &[u8 ]) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Archive

impl StructuralEq for Archive

impl StructuralPartialEq for Archive

Auto Trait Implementations

impl RefUnwindSafe for Archive

impl Send for Archive

impl Sync for Archive

impl Unpin for Archive

impl UnwindSafe for Archive

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.