Struct Located 

pub struct Located { /* private fields */ }

A name behind the path of the instance it is in: a target of a part placed in the part — however deep — or of the part itself, its path empty. Spelled /asm/bolt:model, and /:model for the part itself (Located::parse, its Display), and saved and sent to a front end so.

The tables of one part — its state, its inputs — name what is its own bare, b.pose, and what is of a part placed in it located, /bolt:b.pose (Located::key, key_behind).

Implementations

impl Located

pub fn new(name: impl Into<String>) -> Self

The name name of the part itself.

pub fn in_instance(path: impl Into<String>, name: impl Into<String>) -> Self

The name name of the instance at path: asm/bolt, empty for the part itself.

pub fn path(&self) -> &str

The path of the instance it is in, without the leading separator: asm/bolt, empty for the part itself.

pub fn name(&self) -> &str

The name in that instance.

pub fn local(&self) -> Self

The same name as its instance’s own part names it.

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

The same name of the instance instance of the part — of the instance at that path, if it is already of one: what a name of a placed part is, read from the part it is placed in.

pub fn parse(text: &str) -> GeopResult<Self>

The name text spells: /asm/bolt:model, or /:model for the part itself. Anything else is an error, a bare model too: a name that does not say where it is would be read in the wrong part.

pub fn key(&self) -> String

It as a key of a part’s own table: its bare name for one of the part itself, else as it is spelled.

pub fn of_key(key: &str) -> GeopResult<Self>

The name a key of a part’s own table names (Located::key).

Trait Implementations

impl Clone for Located

fn clone(&self) -> Located

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Located

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

Formats the value using the given formatter.

impl Default for Located

fn default() -> Located

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Located

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Located

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

Formats the value using the given formatter.

impl Eq for Located

impl FromStr for Located

type Err = GeopError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> GeopResult<Self>

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

impl Hash for Located

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Located

fn cmp(&self, other: &Located) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Located

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Located

fn partial_cmp(&self, other: &Located) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Located

fn serialize<Scalar: Serializer>( &self, serializer: Scalar, ) -> Result<Scalar::Ok, Scalar::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Located