Struct robotxt::GroupBuilder

pub struct GroupBuilder { /* private fields */ }

Available on crate feature builder only.

The single formatted user-agent group.

See crate::RobotsBuilder::group.

Implementations

impl GroupBuilder

pub fn new() -> Self

Creates a new builder with default settings.

pub fn header(self, header: &str) -> Self

Adds a local header, usually used for rule notes.

use robotxt::RobotsBuilder;

let txt = RobotsBuilder::default()
    .group(["*"], |u| u.allow("/"))
    .group(["foobot"], |u| {
        u.header("Note: Bad Bot!")
            .disallow("/")
            .allow("/bad/bot.txt")
    });

pub fn allow(self, rule: &str) -> Self

Adds an Allow directive.

use robotxt::RobotsBuilder;

let txt = RobotsBuilder::default()
    .group(["foobot"], |u| {
        u.allow("/").disallow("/secret.txt")
    });

pub fn disallow(self, rule: &str) -> Self

Adds a Disallow directive.

use robotxt::RobotsBuilder;

let txt = RobotsBuilder::default()
    .group(["foobot"], |u| {
        u.allow("/").disallow("/secret.txt")
    });

pub fn crawl_delay(self, delay: u16) -> Self

Adds a Crawl-Delay directive.

use robotxt::RobotsBuilder;

let txt = RobotsBuilder::default()
    .group(["foobot"], |u| {
        u.crawl_delay(5)
    });

pub fn footer(self, footer: &str) -> Self

Adds a local footer, usually used for rule notes.

use robotxt::RobotsBuilder;

let txt = RobotsBuilder::default()
    .group(["foobot"], |u| {
        u.footer("Note: Bad Bot!")
            .disallow("/")
            .allow("/bad/bot.txt")
    });

Trait Implementations

impl Clone for GroupBuilder

fn clone(&self) -> GroupBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupBuilder

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

Formats the value using the given formatter.

impl Default for GroupBuilder

fn default() -> GroupBuilder

Returns the “default value” for a type.

impl Display for GroupBuilder

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

Formats the value using the given formatter.

impl<'ua> FromIterator<&'ua str> for GroupBuilder

fn from_iter<T: IntoIterator<Item = &'ua str>>(iter: T) -> Self

Creates a value from an iterator.