Expand description
Writer to create SourceBundles
.
Writers can either create a new file or be created from an existing file. Then, use
add_file
to add files and finally call finish
to flush the archive to
the underlying writer.
Note that dropping the writer
let mut bundle = SourceBundleWriter::create("bundle.zip")?;
// Add file called "foo.txt"
let file = File::open("my_file.txt")?;
bundle.add_file("foo.txt", file, SourceFileInfo::default())?;
// Flush the bundle to disk
bundle.finish()?;
Implementations
sourceimpl<W> SourceBundleWriter<W> where
W: Seek + Write,
impl<W> SourceBundleWriter<W> where
W: Seek + Write,
sourcepub fn start(writer: W) -> Result<Self, SourceBundleError>
pub fn start(writer: W) -> Result<Self, SourceBundleError>
Creates a bundle writer on the given file.
sourcepub fn set_attribute<K, V>(&mut self, key: K, value: V) -> Option<String> where
K: Into<String>,
V: Into<String>,
pub fn set_attribute<K, V>(&mut self, key: K, value: V) -> Option<String> where
K: Into<String>,
V: Into<String>,
Sets a meta data attribute of the bundle.
Attributes are flushed to the bundle when it is finished. Thus, they can be retrieved or changed at any time before flushing the writer.
If the attribute was set before, the prior value is returned.
sourcepub fn remove_attribute<K>(&mut self, key: K) -> Option<String> where
K: AsRef<str>,
pub fn remove_attribute<K>(&mut self, key: K) -> Option<String> where
K: AsRef<str>,
Removes a meta data attribute of the bundle.
If the attribute was set, the last value is returned.
sourcepub fn attribute<K>(&mut self, key: K) -> Option<&str> where
K: AsRef<str>,
pub fn attribute<K>(&mut self, key: K) -> Option<&str> where
K: AsRef<str>,
Returns the value of a meta data attribute.
sourcepub fn has_file<S>(&self, path: S) -> bool where
S: AsRef<str>,
pub fn has_file<S>(&self, path: S) -> bool where
S: AsRef<str>,
Determines whether a file at the given path has been added already.
sourcepub fn add_file<S, R>(
&mut self,
path: S,
file: R,
info: SourceFileInfo
) -> Result<(), SourceBundleError> where
S: AsRef<str>,
R: Read,
pub fn add_file<S, R>(
&mut self,
path: S,
file: R,
info: SourceFileInfo
) -> Result<(), SourceBundleError> where
S: AsRef<str>,
R: Read,
Adds a file and its info to the bundle.
Multiple files can be added at the same path. For the first duplicate, a counter will be appended to the file name. Any subsequent duplicate increases that counter. For example:
let mut bundle = SourceBundleWriter::create("bundle.zip")?;
// Add file at "foo.txt"
bundle.add_file("foo.txt", File::open("my_duplicate.txt")?, SourceFileInfo::default())?;
assert!(bundle.has_file("foo.txt"));
// Add duplicate at "foo.txt.1"
bundle.add_file("foo.txt", File::open("my_duplicate.txt")?, SourceFileInfo::default())?;
assert!(bundle.has_file("foo.txt.1"));
Returns Ok(true)
if the file was successfully added, or Ok(false)
if the file aready
existed. Otherwise, an error is returned if writing the file fails.
sourcepub fn write_object<'data, 'object, O, E>(
self,
object: &'object O,
object_name: &str
) -> Result<bool, SourceBundleError> where
O: ObjectLike<'data, 'object, Error = E>,
E: Error + Send + Sync + 'static,
pub fn write_object<'data, 'object, O, E>(
self,
object: &'object O,
object_name: &str
) -> Result<bool, SourceBundleError> where
O: ObjectLike<'data, 'object, Error = E>,
E: Error + Send + Sync + 'static,
Writes a single object into the bundle.
Returns Ok(true)
if any source files were added to the bundle, or Ok(false)
if no
sources could be resolved. Otherwise, an error is returned if writing the bundle fails.
This finishes the source bundle and flushes the underlying writer.
sourcepub fn write_object_with_filter<'data, 'object, O, E, F>(
self,
object: &'object O,
object_name: &str,
filter: F
) -> Result<bool, SourceBundleError> where
O: ObjectLike<'data, 'object, Error = E>,
E: Error + Send + Sync + 'static,
F: FnMut(&FileEntry<'_>) -> bool,
pub fn write_object_with_filter<'data, 'object, O, E, F>(
self,
object: &'object O,
object_name: &str,
filter: F
) -> Result<bool, SourceBundleError> where
O: ObjectLike<'data, 'object, Error = E>,
E: Error + Send + Sync + 'static,
F: FnMut(&FileEntry<'_>) -> bool,
Writes a single object into the bundle.
Returns Ok(true)
if any source files were added to the bundle, or Ok(false)
if no
sources could be resolved. Otherwise, an error is returned if writing the bundle fails.
This finishes the source bundle and flushes the underlying writer.
Before a file is written a callback is invoked which can return false
to skip a file.
sourcepub fn finish(self) -> Result<(), SourceBundleError>
pub fn finish(self) -> Result<(), SourceBundleError>
Writes the manifest to the bundle and flushes the underlying file handle.
sourceimpl SourceBundleWriter<BufWriter<File>>
impl SourceBundleWriter<BufWriter<File>>
sourcepub fn create<P>(
path: P
) -> Result<SourceBundleWriter<BufWriter<File>>, SourceBundleError> where
P: AsRef<Path>,
pub fn create<P>(
path: P
) -> Result<SourceBundleWriter<BufWriter<File>>, SourceBundleError> where
P: AsRef<Path>,
Create a bundle writer that writes its output to the given path.
If the file does not exist at the given path, it is created. If the file does exist, it is overwritten.
Auto Trait Implementations
impl<W> RefUnwindSafe for SourceBundleWriter<W> where
W: RefUnwindSafe,
impl<W> Send for SourceBundleWriter<W> where
W: Send,
impl<W> Sync for SourceBundleWriter<W> where
W: Sync,
impl<W> Unpin for SourceBundleWriter<W> where
W: Unpin,
impl<W> UnwindSafe for SourceBundleWriter<W> where
W: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<I, T> ExtractContext<I, ()> for T
impl<I, T> ExtractContext<I, ()> for T
sourcefn extract_context(self, _original_input: I)
fn extract_context(self, _original_input: I)
Given the context attached to a nom error, and given the original input to the nom parser, extract more the useful context information. Read more
impl<T> FmtForward for T
impl<T> FmtForward for T
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self
to use its Binary
implementation when Debug
-formatted. Read more
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Causes self
to use its Octal
implementation when Debug
-formatted. Read more
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
impl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
Pipes by value. This is generally the method you want to use. Read more
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
Borrows self
and passes that borrow into the pipe function. Read more
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self
and passes that borrow into the pipe function. Read more
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.borrow()
into the pipe function. Read more
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.as_ref()
into the pipe function.
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.deref()
into the pipe function.
sourceimpl<I> RecreateContext<I> for I
impl<I> RecreateContext<I> for I
sourcefn recreate_context(_original_input: I, tail: I) -> I
fn recreate_context(_original_input: I, tail: I) -> I
Given the original input, as well as the context reported by nom, recreate a context in the original string where the error occurred. Read more
impl<T> Tap for T
impl<T> Tap for T
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B>
of a value. Read more
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B>
of a value. Read more
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Immutable access to the AsRef<R>
view of a value. Read more
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R>
view of a value. Read more
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the Deref::Target
of a value. Read more
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the Deref::Target
of a value. Read more
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap()
only in debug builds, and is erased in release builds.
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more