Struct VipsSource 

pub struct VipsSource { /* private fields */ }

A unified interface for reading, seeking, and mapping data

Implementations

impl VipsSource

pub fn new_from_reader<R: Reader>(input: R) -> Result<VipsSource>

Create a target from a reader.

pub fn new_from_descriptor(descriptor: i32) -> Result<VipsSource>

Create an source attached to a file descriptor. descriptor is closed with close() when source is finalized.

pub fn new_from_file<P: AsRef<Path>>(filename: P) -> Result<VipsSource>

Create a source attached to a file.

pub fn new_from_memory(buffer: &[u8]) -> Result<VipsSource>

Create a source attached to an area of memory. You must not free data while the source is active.

pub fn new_from_options(option_str: &str) -> Result<VipsSource>

Create a source from an option string.

pub fn minimise(&mut self)

Minimise the source. As many resources as can be safely removed are removed.

pub fn unminimise(&mut self) -> Result<()>

Restore the source after minimisation. This is called at the start of every source method, so loaders should not usually need this.

pub fn decode(&mut self) -> Result<()>

Signal the end of header read and the start of the pixel decode phase. After this, you can no longer seek on this source.

pub fn read(&mut self, length: u64) -> Result<Vec<u8>>

Read up to length bytes from source and store the bytes in buffer.

pub fn is_mappable(&self) -> bool

Whether the source can be efficiently mapped into memory.

pub fn map(&self) -> Result<Vec<u8>>

Map the source entirely into memory and return a pointer to the start.

pub fn seek(&mut self, offset: i64, whence: i32) -> Result<i64>

Move the file read position.

pub fn rewind(&mut self) -> Result<()>

Rewind the source to the start.

pub fn length(&self) -> Result<i64>

Return the length in bytes of the source.

pub fn filename(&self) -> Option<String>

pub fn nick(&self) -> Option<String>

Trait Implementations

impl Clone for VipsSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VipsSource

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

Formats the value using the given formatter.

impl Drop for VipsSource

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a> Setter<'a, &'a VipsSource> for VOption<'a>

fn set(self, name: &str, value: &'a VipsSource) -> VOption<'a>

fn add(&mut self, name: &str, value: &'a VipsSource)