Skip to main content

Payload

Struct Payload 

Source
pub struct Payload<'a> { /* private fields */ }
Expand description

Bytes read into memory, with the source offset of their first byte.

The image decoders read a payload from memory but address it in source coordinates, so their errors keep naming source offsets. As a RangedSource it has the size of its end offset; bytes before its start are not readable.

Implementations§

Source§

impl<'a> Payload<'a>

Source

pub fn new(offset: u64, bytes: &'a [u8]) -> Result<Self>

bytes start at source offset offset; their end must fit a u64.

Source

pub fn offset(&self) -> u64

The source offset of the first byte.

Source

pub fn bytes(&self) -> &'a [u8] ⓘ

Source

pub fn end(&self) -> u64

The source offset just past the last byte.

Source

pub fn get(&self, start: u64, length: u64) -> Option<&'a [u8]>

The length bytes at source offset start, if all lie in this payload.

Trait Implementations§

Source§

impl<'a> Clone for Payload<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Payload<'a>

Source§

impl<'a> Debug for Payload<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for Payload<'a>

Source§

fn default() -> Self

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

impl<'a> From<&'a [u8]> for Payload<'a>

A slice starting at source offset zero.

Source§

fn from(bytes: &'a [u8]) -> Self

Converts to this type from the input type.
Source§

impl RangedSource for Payload<'_>

Source§

fn size(&self) -> u64

Source§

fn read_at(&mut self, offset: u64, destination: &mut [u8]) -> Result<usize>

Auto Trait Implementations§

§

impl<'a> Freeze for Payload<'a>

§

impl<'a> RefUnwindSafe for Payload<'a>

§

impl<'a> Send for Payload<'a>

§

impl<'a> Sync for Payload<'a>

§

impl<'a> Unpin for Payload<'a>

§

impl<'a> UnsafeUnpin for Payload<'a>

§

impl<'a> UnwindSafe for Payload<'a>

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.