[go: up one dir, main page]
epub::archive

Struct EpubArchive

Source 
pub struct EpubArchive<R: Read + Seek> {
    pub path: PathBuf,
    pub files: Vec<String>,
    /* private fields */
}
Expand description

Epub archive struct. Here it’s stored the file path and the list of files in the zip archive.

Fields§

§path: PathBuf§files: Vec<String>

Implementations§

Source§

impl EpubArchive<BufReader<File>>

Source

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self, ArchiveError>

Opens the epub file in path.

§Errors

Returns an error if the zip is broken or if the file doesn’t exists.

Source§

impl<R: Read + Seek> EpubArchive<R>

Source

pub fn from_reader(reader: R) -> Result<Self, ArchiveError>

Opens the epub contained in reader.

§Errors

Returns an error if the zip is broken.

Source

pub fn get_entry<P: AsRef<Path>>( &mut self, name: P, ) -> Result<Vec<u8>, ArchiveError>

Returns the content of the file by the name as Vec<u8>.

§Errors

Returns an error if the name doesn’t exists in the zip archive.

Source

pub fn get_entry_as_str<P: AsRef<Path>>( &mut self, name: P, ) -> Result<String, ArchiveError>

Returns the content of the file by the name as String.

§Errors

Returns an error if the name doesn’t exists in the zip archive.

Source

pub fn get_container_file(&mut self) -> Result<Vec<u8>, ArchiveError>

Returns the content of container file “META-INF/container.xml”.

§Errors

Returns an error if the epub doesn’t have the container file.

Trait Implementations§

Source§

impl<R: Clone + Read + Seek> Clone for EpubArchive<R>

Source§

fn clone(&self) -> EpubArchive<R>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<R: Debug + Read + Seek> Debug for EpubArchive<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for EpubArchive<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for EpubArchive<R>
where R: RefUnwindSafe,

§

impl<R> Send for EpubArchive<R>
where R: Send,

§

impl<R> Sync for EpubArchive<R>
where R: Sync,

§

impl<R> Unpin for EpubArchive<R>
where R: Unpin,

§

impl<R> UnwindSafe for EpubArchive<R>
where R: 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> 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.