Struct rpsl::ObjectView

pub struct ObjectView<'a> { /* private fields */ }

A view into an RPSL object in textual representation somewhere in memory.

This is the borrowed equivalent of an Object, only containing references to the original data in the form of AttributeViews. It presents largely the same interface as its owned equivalent, although it will always return references.

role:           ACME Company ◀─────────────── &"role"    ───  &"ACME Company"
address:        Packet Street 6 ◀──────────── &"address" ─┬─  &"Packet Street 6"
                128 Series of Tubes ◀────────             ├─  &"128 Series of Tubes"
                Internet ◀───────────────────             └─  &"Internet"
email:          rpsl-rs@github.com ◀───────── &"email"   ───  &"rpsl-rs@github.com"
nic-hdl:        RPSL1-RIPE ◀───────────────── &"nic-hdl" ───  &"RPSL1-RIPE"
source:         RIPE ◀─────────────────────── &"source"  ───  &"RIPE"

Since an ObjectView is purely used to provide a view into referenced RPSL data, it can only be created from RPSL text using the parse_object and parse_whois_response functions.

Examples

Like an owned Object, its attributes can be accessed by index.

assert_eq!(role_acme[0], Attribute::new("role".parse()?, "ACME Company".parse()?));
assert_eq!(role_acme[3], Attribute::new("nic-hdl".parse()?, "RPSL1-RIPE".parse()?));

While specific attribute values can be accessed by name.

assert_eq!(role_acme.get("role"), vec!["ACME Company"]);
assert_eq!(role_acme.get("address"), vec!["Packet Street 6", "128 Series of Tubes", "Internet"]);
assert_eq!(role_acme.get("email"), vec!["rpsl-rs@github.com"]);
assert_eq!(role_acme.get("nic-hdl"), vec!["RPSL1-RIPE"]);
assert_eq!(role_acme.get("source"), vec!["RIPE"]);

Views can be compared to their owned equivalents.

assert_eq!(
    role_acme,
    object! {
        "role": "ACME Company";
        "address": "Packet Street 6", "128 Series of Tubes", "Internet";
        "email": "rpsl-rs@github.com";
        "nic-hdl": "RPSL1-RIPE";
        "source": "RIPE";
     },
);

As well as converted to them if required.

role_acme.to_owned();

Implementations

impl<'a> ObjectView<'a>

pub fn to_owned(&self) -> Object

Turn the view into an owned Object.

pub fn len(&self) -> usize

The number of attributes referenced within the view.

pub fn get(&self, name: &str) -> Vec<&str>

Get the value(s) of specific attribute(s).

Trait Implementations

impl<'a> Clone for ObjectView<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectView<'_>

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

Formats the value using the given formatter.

impl Display for ObjectView<'_>

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

Display the view as RPSL.

impl<'a> Index<usize> for ObjectView<'a>

type Output = AttributeView<'a>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for ObjectView<'a>

type Item = AttributeView<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<<ObjectView<'a> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Object> for ObjectView<'_>

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

fn eq(&self, other: &ObjectView<'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> Eq for ObjectView<'a>

impl<'a> StructuralEq for ObjectView<'a>

impl<'a> StructuralPartialEq for ObjectView<'a>