Struct glib::Checksum

pub struct Checksum(_);

An opaque structure representing a checksumming operation. To create a new GChecksum, use new(). To free a GChecksum, use g_checksum_free().

Implementations

impl Checksum

pub fn new(checksum_type: ChecksumType) -> Option<Checksum>

Creates a new Checksum, using the checksum algorithm checksum_type. If the checksum_type is not known, None is returned. A Checksum can be used to compute the checksum, or digest, of an arbitrary binary blob, using different hashing algorithms.

A Checksum works by feeding a binary blob through update() until there is data to be checked; the digest can then be extracted using string(), which will return the checksum as a hexadecimal string; or digest(), which will return a vector of raw bytes. Once either string() or digest() have been called on a Checksum, the checksum will be closed and it won’t be possible to call update() on it anymore.

checksum_type

the desired type of checksum

Returns

the newly created Checksum, or None. Use g_checksum_free() to free the memory allocated by it.

pub fn reset(&mut self)

Resets the state of the self back to its initial state.

pub fn update(&mut self, data: &[u8])

Feeds data into an existing Checksum. The checksum must still be open, that is string() or digest() must not have been called on self.

data

buffer used to compute the checksum

pub fn type_get_length(checksum_type: ChecksumType) -> isize

Gets the length in bytes of digests of type checksum_type

checksum_type

a ChecksumType

Returns

the checksum length, or -1 if checksum_type is not supported.

impl Checksum

pub fn digest(self) -> Vec<u8>

Gets the digest from self as a raw binary vector and places it into buffer. The size of the digest depends on the type of checksum.

Once this function has been called, the Checksum is closed and can no longer be updated with update().

buffer

output buffer

pub fn string(self) -> Option<String>

Gets the digest as a hexadecimal string.

Once this function has been called the Checksum can no longer be updated with update().

The hexadecimal characters will be lower case.

Returns

the hexadecimal representation of the checksum. The returned string is owned by the checksum and should not be modified or freed.

Trait Implementations

impl Clone for Checksum

fn clone(&self) -> Checksum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Checksum

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

Formats the value using the given formatter.

impl Hash for Checksum

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Checksum

fn cmp(&self, other: &Checksum) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Checksum> for Checksum

fn eq(&self, other: &Checksum) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Checksum) -> bool

This method tests for !=.

impl PartialOrd<Checksum> for Checksum

fn partial_cmp(&self, other: &Checksum) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Checksum

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Checksum

impl Send for Checksum

impl StructuralEq for Checksum

impl StructuralPartialEq for Checksum

impl Sync for Checksum