Struct Checksum

pub struct Checksum { /* private fields */ }

GLib provides a generic API for computing checksums (or ‘digests’) for a sequence of arbitrary bytes, using various hashing algorithms like MD5, SHA-1 and SHA-256. Checksums are commonly used in various environments and specifications.

To create a new GChecksum, use GLib::Checksum::new(). To free a GChecksum, use GLib::Checksum::free().

GLib supports incremental checksums using the GChecksum data structure, by calling update() as long as there’s data available and then using string() or digest() to compute the checksum and return it either as a string in hexadecimal form, or as a raw sequence of bytes. To compute the checksum for binary blobs and nul-terminated strings in one go, use the convenience functions compute_checksum_for_data() and compute_checksum_for_string(), respectively.

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl Checksum

pub fn as_ptr(&self) -> *mut GChecksum

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GChecksum) -> &Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut(ptr: &mut *mut GChecksum) -> &mut Self

Borrows the underlying C value mutably.

impl Checksum

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

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

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

checksum_type

the desired type of checksum

Returns

the newly created #GChecksum, 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 #GChecksum. The checksum must still be open, that is g_checksum_get_string() or g_checksum_get_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 #GChecksumType

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 #GChecksum is closed and can no longer be updated with g_checksum_update().

buffer

output buffer

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

Gets the digest as a hexadecimal string.

Once this function has been called the #GChecksum can no longer be updated with g_checksum_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) -> Self

Copies the boxed type with the type-specific copy function.

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 From<Checksum> for Value

fn from(o: Checksum) -> Self

Converts to this type from the input type.

impl HasParamSpec for Checksum

type ParamSpec = ParamSpecBoxed

type SetValue = Checksum

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Checksum>

fn param_spec_builder() -> Self::BuilderFn

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, Self: Sized,

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Checksum

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 StructuralPartialEq for Checksum

impl Sync for Checksum