Struct Ref

pub struct Ref<'id, 'collection: 'id, D> { /* private fields */ }

An ID for a resource that may be in the backing collection.

Ref is used to allow exploration of STIX collections when not every object referenced is present in-memory.

Implementations

impl<'id, 'collection: 'id, D> Ref<'id, 'collection, D>

pub fn id(&self) -> &'id Id

The ID the Ref will look up in the collection.

impl<'id, 'collection: 'id> Ref<'id, 'collection, Declaration>

The ID of a STIX object of some type which may be present in the collection.

pub fn downcast<D: TypedObject>(self) -> Option<Ref<'id, 'collection, D>>

Narrow the type of the reference so that it can be resolved to a Node. This requires knowing the concrete type of the data associated with the ID.

impl<'id, 'collection: 'id> Ref<'id, 'collection, AttackPattern>

pub fn resolve(self) -> Option<Node<'collection, AttackPattern>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, CourseOfAction>

pub fn resolve(self) -> Option<Node<'collection, CourseOfAction>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Malware>

pub fn resolve(self) -> Option<Node<'collection, Malware>>

Examples found in repository

examples/actor_lookup.rs (line 18)

fn display_actor<'a>(actor: &Node<'a, IntrusionSet>) {
    println!("{} ({})", actor.name(), actor.id());
    println!("============");

    if let Some(description) = actor.description() {
        println!("{}\n", description);
    }

    let mut malwares = actor.uses_malware().peekable();
    if malwares.peek().is_some() {
        println!("Malware:");
        for malware in malwares {
            match malware.resolve() {
                Some(malware) => {
                    println!("- {} ({})", malware.name(), malware.id());
                }
                None => {
                    println!("- Unknown Malware");
                }
            }
        }
    }

    let mut tools = actor.uses_tools().peekable();
    if tools.peek().is_some() {
        println!("Tools:");
        for tool in tools {
            match tool.resolve() {
                Some(tool) => {
                    println!("- {} ({})", tool.name(), tool.id());
                }
                None => {
                    println!("- Unknown Tool");
                }
            }
        }
    }
}

impl<'id, 'collection: 'id> Ref<'id, 'collection, Matrix>

pub fn resolve(self) -> Option<Node<'collection, Matrix>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Tactic>

pub fn resolve(self) -> Option<Node<'collection, Tactic>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Tool>

pub fn resolve(self) -> Option<Node<'collection, Tool>>

Examples found in repository

examples/actor_lookup.rs (line 33)

fn display_actor<'a>(actor: &Node<'a, IntrusionSet>) {
    println!("{} ({})", actor.name(), actor.id());
    println!("============");

    if let Some(description) = actor.description() {
        println!("{}\n", description);
    }

    let mut malwares = actor.uses_malware().peekable();
    if malwares.peek().is_some() {
        println!("Malware:");
        for malware in malwares {
            match malware.resolve() {
                Some(malware) => {
                    println!("- {} ({})", malware.name(), malware.id());
                }
                None => {
                    println!("- Unknown Malware");
                }
            }
        }
    }

    let mut tools = actor.uses_tools().peekable();
    if tools.peek().is_some() {
        println!("Tools:");
        for tool in tools {
            match tool.resolve() {
                Some(tool) => {
                    println!("- {} ({})", tool.name(), tool.id());
                }
                None => {
                    println!("- Unknown Tool");
                }
            }
        }
    }
}

impl<'id, 'collection: 'id> Ref<'id, 'collection, Campaign>

pub fn resolve(self) -> Option<Node<'collection, Campaign>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Identity>

pub fn resolve(self) -> Option<Node<'collection, Identity>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, IntrusionSet>

pub fn resolve(self) -> Option<Node<'collection, IntrusionSet>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Infrastructure>

pub fn resolve(self) -> Option<Node<'collection, Infrastructure>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Location>

pub fn resolve(self) -> Option<Node<'collection, Location>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, MarkingDefinition>

pub fn resolve(self) -> Option<Node<'collection, MarkingDefinition>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Relationship>

pub fn resolve(self) -> Option<Node<'collection, Relationship>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, ThreatActor>

pub fn resolve(self) -> Option<Node<'collection, ThreatActor>>

impl<'id, 'collection: 'id> Ref<'id, 'collection, Vulnerability>

pub fn resolve(self) -> Option<Node<'collection, Vulnerability>>

Trait Implementations

impl<'id, 'collection: 'id, D> Clone for Ref<'id, 'collection, D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D> Display for Ref<'_, '_, D>

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

Formats the value using the given formatter.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, AttackPattern>

type Output = Node<'collection, AttackPattern>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Campaign>

type Output = Node<'collection, Campaign>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, CourseOfAction>

type Output = Node<'collection, CourseOfAction>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Identity>

type Output = Node<'collection, Identity>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Infrastructure>

type Output = Node<'collection, Infrastructure>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, IntrusionSet>

type Output = Node<'collection, IntrusionSet>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Location>

type Output = Node<'collection, Location>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Malware>

type Output = Node<'collection, Malware>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, MarkingDefinition>

type Output = Node<'collection, MarkingDefinition>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Matrix>

type Output = Node<'collection, Matrix>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Relationship>

type Output = Node<'collection, Relationship>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Tactic>

type Output = Node<'collection, Tactic>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, ThreatActor>

type Output = Node<'collection, ThreatActor>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Tool>

type Output = Node<'collection, Tool>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.

impl<'id, 'collection: 'id> Resolve for Ref<'id, 'collection, Vulnerability>

type Output = Node<'collection, Vulnerability>

The node type, containing a reference to the data and the backing collection.

fn resolve(self) -> Option<Self::Output>

Produce a collection-attached node for the object identified by the ID.