Skip to main content

Card

Struct Card 

Source
pub struct Card {
    pub header: CardHeader,
    pub metadata: CardMetadata,
    pub payload: Vec<u8>,
}
👎Deprecated: Use GenericCard with your own CardFormat instead
Expand description

A DataCard: BytePunch-compressed CML document with metadata

Fields§

§header: CardHeader
👎Deprecated: Use GenericCard with your own CardFormat instead

Card header

§metadata: CardMetadata
👎Deprecated: Use GenericCard with your own CardFormat instead

Document metadata

§payload: Vec<u8>
👎Deprecated: Use GenericCard with your own CardFormat instead

Compressed CML data

Implementations§

Source§

impl Card

Source

pub fn from_cml( cml: &str, metadata: CardMetadata, dictionary: &Dictionary, ) -> Result<Self>

👎Deprecated: Use GenericCard with your own CardFormat instead

Create a card from CML content

Source

pub fn from_cml_with_checksum( cml: &str, metadata: CardMetadata, dictionary: &Dictionary, ) -> Result<Self>

👎Deprecated: Use GenericCard with your own CardFormat instead

Create a card from CML content with checksum

Source

pub fn from_compressed(metadata: CardMetadata, payload: Vec<u8>) -> Result<Self>

👎Deprecated: Use GenericCard with your own CardFormat instead

Create card from pre-compressed data

Source

pub fn from_compressed_with_checksum( metadata: CardMetadata, payload: Vec<u8>, ) -> Result<Self>

👎Deprecated: Use GenericCard with your own CardFormat instead

Create card from pre-compressed data with checksum

Source

pub fn to_cml(&self, dictionary: &Dictionary) -> Result<String>

👎Deprecated: Use GenericCard with your own CardFormat instead

Decompress card back to CML content

Source

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self>

👎Deprecated: Use GenericCard with your own CardFormat instead

Load card from file

Source

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

👎Deprecated: Use GenericCard with your own CardFormat instead

Save card to file

Source

pub fn calculate_checksum(&self) -> u32

👎Deprecated: Use GenericCard with your own CardFormat instead

Calculate CRC32 checksum for this card

Source

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

👎Deprecated: Use GenericCard with your own CardFormat instead

Serialize card to bytes

Source

pub fn from_bytes(data: &[u8]) -> Result<Self>

👎Deprecated: Use GenericCard with your own CardFormat instead

Deserialize card from bytes

Source

pub fn compressed_size(&self) -> usize

👎Deprecated: Use GenericCard with your own CardFormat instead

Get compressed size in bytes

Source

pub fn original_size(&self) -> Option<u64>

👎Deprecated: Use GenericCard with your own CardFormat instead

Get original size if available

Source

pub fn compression_ratio(&self) -> Option<f64>

👎Deprecated: Use GenericCard with your own CardFormat instead

Get compression ratio (original / compressed)

Source

pub fn id(&self) -> &str

👎Deprecated: Use GenericCard with your own CardFormat instead

Get document ID

Source

pub fn profile(&self) -> Option<&str>

👎Deprecated: Use GenericCard with your own CardFormat instead

Get CML profile if set

Source

pub fn has_checksum(&self) -> bool

👎Deprecated: Use GenericCard with your own CardFormat instead

Check if card has checksum

Trait Implementations§

Source§

impl Clone for Card

Source§

fn clone(&self) -> Card

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 Debug for Card

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Card

§

impl RefUnwindSafe for Card

§

impl Send for Card

§

impl Sync for Card

§

impl Unpin for Card

§

impl UnwindSafe for Card

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.