Struct adstxt::AdsTxt

pub struct AdsTxt<'a> {
    pub records: Vec<(Record<'a>, Option<Extension<'a>>)>,
    pub variables: Vec<(Variable<'a>, Option<Extension<'a>>)>,
}

Represents ads.txt data.

Fields

records: Vec<(Record<'a>, Option<Extension<'a>>)>

variables: Vec<(Variable<'a>, Option<Extension<'a>>)>

Implementations

impl AdsTxt<'_>

pub fn parse(data: &str) -> AdsTxt<'_>

Parse the contents of ads.txt.

See also AdsTxt::parse_lines.

Example

assert_eq!(
    AdsTxt::parse(
        "# comment
placeholder.example.com, placeholder, DIRECT, placeholder # Comment
contact=adops@example.com

unknown"
    ),
    AdsTxt {
        records: vec![(
            Record {
                domain: "placeholder.example.com",
                account_id: "placeholder",
                relation: Relation::Direct,
                authority_id: Some("placeholder"),
            },
            None
        )],
        variables: vec![(Variable { name: "contact", value: "adops@example.com" }, None)],
    }
);

pub fn parse_lines(data: &str) -> Vec<LineData<'_>>

Parse the contents of ads.txt.

The line data are mapped to LineData. See also AdsTxt::parse.

Example

assert_eq!(
    AdsTxt::parse_lines(
        "# comment
placeholder.example.com, placeholder, DIRECT, placeholder # Comment
contact=adops@example.com

unknown"
    ),
    vec![
        LineData::Comment(Comment("# comment")),
        LineData::Record {
            record: Record {
                domain: "placeholder.example.com",
                account_id: "placeholder",
                relation: Relation::Direct,
                authority_id: Some("placeholder"),
            },
            extension: None,
            comment: Some(Comment("# Comment"))
        },
        LineData::Variable {
            variable: Variable { name: "contact", value: "adops@example.com" },
            extension: None,
            comment: None
        },
        LineData::Empty,
        LineData::Unknown("unknown"),
    ]
);

Trait Implementations

impl<'a> Clone for AdsTxt<'a>

fn clone(&self) -> AdsTxt<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AdsTxt<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for AdsTxt<'a>

fn eq(&self, other: &AdsTxt<'a>) -> 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<'a> StructuralPartialEq for AdsTxt<'a>