Struct Documentation

pub struct Documentation {
    pub document_label: Option<DocumentLabel>,
    pub document_url: Option<Url>,
}

Fields

document_label: Option<DocumentLabel>

The label of the documentation for providing software guides such as manuals and troubleshooting URLs.

document_url: Option<Url>

The URL for a documentation.

Implementations

impl Documentation

pub const fn is_empty(&self) -> bool

Returns true if all fields of the Documentation are empty.

Examples

use winget_types::locale::{Documentation, DocumentLabel};

let mut documentation = Documentation::default();
assert!(documentation.is_empty());

documentation.document_label = Some(DocumentLabel::new("Label").unwrap());
assert!(!documentation.is_empty());

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl Default for Documentation

fn default() -> Documentation

Returns the “default value” for a type.

impl Hash for Documentation

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 Documentation

fn cmp(&self, other: &Documentation) -> 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 Documentation

fn eq(&self, other: &Documentation) -> 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 Documentation

fn partial_cmp(&self, other: &Documentation) -> 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 Eq for Documentation

impl StructuralPartialEq for Documentation