Struct sectxtlib::SecurityTxt

pub struct SecurityTxt {
    pub acknowledgments: Vec<AcknowledgmentsField>,
    pub canonical: Vec<CanonicalField>,
    pub contact: Vec<ContactField>,
    pub encryption: Vec<EncryptionField>,
    pub expires: ExpiresField,
    pub extension: Vec<ExtensionField>,
    pub hiring: Vec<HiringField>,
    pub policy: Vec<PolicyField>,
    pub preferred_languages: Option<PreferredLanguagesField>,
}

A representation of an RFC 9116 security.txt file

Fields

acknowledgments: Vec<AcknowledgmentsField>

A collection of “Acknowledgments” fields

canonical: Vec<CanonicalField>

A collection of “Canonical” fields

contact: Vec<ContactField>

A collection of “Contact” fields

encryption: Vec<EncryptionField>

A collection of “Encryption” fields

expires: ExpiresField

The “Expires” field

extension: Vec<ExtensionField>

A collection of “Extension” fields

hiring: Vec<HiringField>

A collection of “Hiring” fields

policy: Vec<PolicyField>

A collection of “Policy” fields

preferred_languages: Option<PreferredLanguagesField>

The “Preferred-Languages” field, if available

Implementations

impl SecurityTxt

pub fn parse(text: &str) -> Result<Self, ParseError>

Parses a security.txt file as a string according to RFC 9116.

pub fn parse_with( text: &str, options: &SecurityTxtOptions ) -> Result<Self, ParseError>

Parses a security.txt file as a string according to RFC 9116.

Trait Implementations

impl Debug for SecurityTxt

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

Formats the value using the given formatter.

impl FromStr for SecurityTxt

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SecurityTxt

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

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

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

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

impl PartialOrd for SecurityTxt

fn partial_cmp(&self, other: &Self) -> 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 Structable for SecurityTxt

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl Valuable for SecurityTxt

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.

impl StructuralPartialEq for SecurityTxt