Struct Data

pub struct Data { /* private fields */ }

A type containing some data and metadata for it.

This often, but not always, corresponds to data which could potentially have been a file in a file system. For example a image or a text document.

This type is mainly used when having auto generated content as content provided through a file should be loaded from a source and as such will be directly loaded and transfer encoded.

Clone

Data is made to be cheap to clone and share. For this it uses Arc internally.

Implementations

impl Data

pub fn new(buffer: impl Into<Arc<[u8]>>, meta: impl Into<Arc<Metadata>>) -> Self

Create a new data instance.

pub fn plain_text(text: impl Into<String>, cid: ContentId) -> Data

pub fn buffer(&self) -> &Arc<[u8]>

Access the raw data buffer of this instance.

pub fn metadata(&self) -> &Arc<Metadata>

Access the metadata.

pub fn file_meta(&self) -> &FileMeta

Access the file meta metadata.Fn

pub fn media_type(&self) -> &MediaType

Access the content type.

pub fn content_id(&self) -> &ContentId

Access the content id.

pub fn transfer_encode(&self, encoding_hint: TransferEncodingHint) -> EncData

Transfer encode the given data.

This function will be called by the context implementation when loading and/or transfer encoding data. The context implementation might also not call it if it has a cached version of the transfer encoded data.

This functions expect a boundary pool and will remove all boundaries which do appear in the encoded representation of the data.

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Data

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Data

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Data

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.