Struct cfb::CompoundFile [−][src]
pub struct CompoundFile<F> { /* fields omitted */ }
Expand description
Implementations
Returns information about the root storage object. This is equivalent
to self.entry("/").unwrap()
(but always succeeds).
Given a path within the compound file, get information about that stream or storage object.
Returns an iterator over the entries within a storage object.
Returns an iterator over all entries under a storage subtree, including the given path itself. The iterator walks the storage tree in a preorder traversal.
Returns true if there is an existing stream or storage at the given path, or false if there is nothing at that path.
Returns true if there is an existing stream at the given path, or false if there is a storage or nothing at that path.
Returns true if there is an existing storage at the given path, or false if there is a stream or nothing at that path.
Consumes the CompoundFile
, returning the underlying reader/writer.
Opens an existing compound file, using the underlying reader. If the
underlying reader also supports the Write
trait, then the
CompoundFile
object will be writable as well.
Creates a new compound file with no contents, using the underlying reader/writer. The reader/writer should be initially empty.
Creates a new compound file of the given version with no contents, using the underlying writer. The writer should be initially empty.
Creates a new, empty storage object (i.e. “directory”) at the provided path. The parent storage object must already exist.
Recursively creates a storage and all of its parent storages if they are missing.
Removes the storage object at the provided path. The storage object must exist and have no children.
Recursively removes a storage and all of its children. If called on the root storage, recursively removes all of its children but not the root storage itself (which cannot be removed).
Sets the CLSID for the storage object at the provided path. (To get
the current CLSID for a storage object, use
self.entry(path)?.clsid()
.)
Creates and returns a new, empty stream object at the provided path. If a stream already exists at that path, it will be replaced by the new stream. The parent storage object must already exist.
Creates and returns a new, empty stream object at the provided path. Returns an error if a stream already exists at that path. The parent storage object must already exist.
Removes the stream object at the provided path.
Sets the user-defined bitflags for the object at the provided path.
(To get the current state bits for an object, use
self.entry(path)?.state_bits()
.)
Sets the modified time for the object at the given path to now. Has no effect when called on the root storage.