Struct staging_xcm_builder::test_utils::Location

pub struct Location {
    pub parents: u8,
    pub interior: Junctions,
}

Expand description

A relative path between state-bearing consensus systems.

A location in a consensus system is defined as an isolatable state machine held within global consensus. The location in question need not have a sophisticated consensus algorithm of its own; a single account within Ethereum, for example, could be considered a location.

A very-much non-exhaustive list of types of location include:

A (normal, layer-1) block chain, e.g. the Bitcoin mainnet or a parachain.
A layer-0 super-chain, e.g. the Polkadot Relay chain.
A layer-2 smart contract, e.g. an ERC-20 on Ethereum.
A logical functional component of a chain, e.g. a single instance of a pallet on a Frame-based Substrate chain.
An account.

A Location is a relative identifier, meaning that it can only be used to define the relative path between two locations, and cannot generally be used to refer to a location universally. It is comprised of an integer number of parents specifying the number of times to “escape” upwards into the containing consensus system and then a number of junctions, each diving down and specifying some interior portion of state (which may be considered a “sub-consensus” system).

This specific Location implementation uses a Junctions datatype which is a Rust enum in order to make pattern matching easier. There are occasions where it is important to ensure that a value is strictly an interior location, in those cases, Junctions may be used.

The Location value of Null simply refers to the interpreting consensus system.

Fields§

§parents: u8

The number of parent junctions at the beginning of this Location.

§interior: Junctions

The interior (i.e. non-parent) junctions that this Location contains.

Implementations§

§

impl Location

pub fn new(parents: u8, interior: impl Into<Junctions>) -> Location

Creates a new Location with the given number of parents and interior junctions.

pub const fn into_versioned(self) -> VersionedLocation

Consume self and return the equivalent VersionedLocation value.

pub const fn here() -> Location

Creates a new Location with 0 parents and a Here interior.

The resulting Location can be interpreted as the “current consensus system”.

pub const fn parent() -> Location

Creates a new Location which evaluates to the parent context.

pub const fn ancestor(parents: u8) -> Location

Creates a new Location with parents and an empty (Here) interior.

pub fn is_here(&self) -> bool

Whether the Location has no parents and has a Here interior.

pub fn remove_network_id(&mut self)

Remove the NetworkId value in any interior Junctions.

pub fn interior(&self) -> &Junctions

Return a reference to the interior field.

pub fn interior_mut(&mut self) -> &mut Junctions

Return a mutable reference to the interior field.

pub const fn parent_count(&self) -> u8

Returns the number of Parent junctions at the beginning of self.

pub fn unpack(&self) -> (u8, &[Junction])

Returns the parent count and the interior Junctions as a tuple.

To be used when pattern matching, for example:

fn get_parachain_id(loc: &Location) -> Option<u32> {
    match loc.unpack() {
        (0, [Parachain(id)]) => Some(*id),
        _ => None
    }
}

pub const fn contains_parents_only(&self, count: u8) -> bool

Returns boolean indicating whether self contains only the specified amount of parents and no interior junctions.

pub fn len(&self) -> usize

Returns the number of parents and junctions in self.

pub fn first_interior(&self) -> Option<&Junction>

Returns the first interior junction, or None if the location is empty or contains only parents.

pub fn last(&self) -> Option<&Junction>

Returns last junction, or None if the location is empty or contains only parents.

pub fn split_first_interior(self) -> (Location, Option<Junction>)

Splits off the first interior junction, returning the remaining suffix (first item in tuple) and the first element (second item in tuple) or None if it was empty.

pub fn split_last_interior(self) -> (Location, Option<Junction>)

Splits off the last interior junction, returning the remaining prefix (first item in tuple) and the last element (second item in tuple) or None if it was empty or if self only contains parents.

pub fn push_interior( &mut self, new: impl Into<Junction> ) -> Result<(), Junction>

Mutates self, suffixing its interior junctions with new. Returns Err with new in case of overflow.

pub fn push_front_interior( &mut self, new: impl Into<Junction> ) -> Result<(), Junction>

Mutates self, prefixing its interior junctions with new. Returns Err with new in case of overflow.

pub fn pushed_with_interior( self, new: impl Into<Junction> ) -> Result<Location, (Location, Junction)>

Consumes self and returns a Location suffixed with new, or an Err with the original value of self in case of overflow.

pub fn pushed_front_with_interior( self, new: impl Into<Junction> ) -> Result<Location, (Location, Junction)>

Consumes self and returns a Location prefixed with new, or an Err with the original value of self in case of overflow.

pub fn at(&self, i: usize) -> Option<&Junction>

Returns the junction at index i, or None if the location is a parent or if the location does not contain that many elements.

pub fn at_mut(&mut self, i: usize) -> Option<&mut Junction>

Returns a mutable reference to the junction at index i, or None if the location is a parent or if it doesn’t contain that many elements.

pub fn dec_parent(&mut self)

Decrements the parent count by 1.

pub fn take_first_interior(&mut self) -> Option<Junction>

Removes the first interior junction from self, returning it (or None if it was empty or if self contains only parents).

pub fn take_last(&mut self) -> Option<Junction>

Removes the last element from interior, returning it (or None if it was empty or if self only contains parents).

pub fn match_and_split(&self, prefix: &Location) -> Option<&Junction>

Ensures that self has the same number of parents as prefix, its junctions begins with the junctions of prefix and that it has a single Junction item following. If so, returns a reference to this Junction item.

§Example

let mut m = Location::new(1, [PalletInstance(3), OnlyChild]);
assert_eq!(
    m.match_and_split(&Location::new(1, [PalletInstance(3)])),
    Some(&OnlyChild),
);
assert_eq!(m.match_and_split(&Location::new(1, Here)), None);

let m: Location = (Parent, Parent, PalletInstance(3)).into();
let r = m.prepended_with((Parent, Parachain(21), OnlyChild)).unwrap();
assert_eq!(r, Location::new(1, [PalletInstance(3)]));

pub fn simplify(&mut self, context: &Junctions)

Remove any unneeded parents/junctions in self based on the given context it will be interpreted in.

pub fn chain_location(&self) -> Location

Return the Location subsection identifying the chain that self points to.

Trait Implementations§

§

impl Clone for Location

§

fn clone(&self) -> Location

fn decode_into( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>
where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory. Read more

§

fn skip(input: &mut I) -> Result<(), Error>
where I: Input,

Attempt to skip the encoded value from input. Read more

Convert self to a slice and append it to the destination.

§

fn encode(&self) -> Vec<u8> ⓘ

Convert self to an owned vector.

§

fn using_encoded<R, F>(&self, f: F) -> R
where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

Attempt to convert reference of B into value of A, returning None if not possible.

§

impl Ord for Location

§

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

This method returns an Ordering between self and other. Read more

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

§

impl PartialEq for Location

§

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

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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.

§

Consume self to return Some equivalent value of Option<T>. Read more

§

impl<T> Clear for T
where T: Default + Eq + PartialEq,

§

fn is_clear(&self) -> bool

True iff no bits are set.

Decode Self with the given maximum recursion depth and advance input by the number of bytes consumed. Read more

§

impl<T> DefensiveMax<T> for T
where T: PartialOrd,

§

fn defensive_max(self, other: T) -> T

Returns the maximum and defensively asserts that other is not larger than self. Read more

§

fn defensive_strict_max(self, other: T) -> T

source §

fn from(t: T) -> T

Returns the argument unchanged.

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§

impl<T, U> IntoKey for T
where U: FromKey<T>,

§

fn into_key(self) -> U

§

impl<T> IsType<T> for T

§

fn from_ref(t: &T) -> &T

Cast reference.

§

fn into_ref(&self) -> &T

Cast reference.

§

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

§

fn into_mut(&mut self) -> &mut T

Cast mutable reference.

§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

Consume self to return an equivalent value of T. Read more

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

§

§

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Fields§

Implementations§

impl Location

pub fn new(parents: u8, interior: impl Into<Junctions>) -> Location

pub const fn into_versioned(self) -> VersionedLocation

pub const fn here() -> Location

pub const fn parent() -> Location

pub const fn ancestor(parents: u8) -> Location

pub fn is_here(&self) -> bool

pub fn remove_network_id(&mut self)

pub fn interior(&self) -> &Junctions

pub fn interior_mut(&mut self) -> &mut Junctions

pub const fn parent_count(&self) -> u8

pub fn unpack(&self) -> (u8, &[Junction])

pub const fn contains_parents_only(&self, count: u8) -> bool

pub fn len(&self) -> usize

pub fn first_interior(&self) -> Option<&Junction>

pub fn last(&self) -> Option<&Junction>

pub fn split_first_interior(self) -> (Location, Option<Junction>)

pub fn split_last_interior(self) -> (Location, Option<Junction>)

pub fn push_interior( &mut self, new: impl Into<Junction> ) -> Result<(), Junction>

pub fn push_front_interior( &mut self, new: impl Into<Junction> ) -> Result<(), Junction>

pub fn pushed_with_interior( self, new: impl Into<Junction> ) -> Result<Location, (Location, Junction)>

pub fn pushed_front_with_interior( self, new: impl Into<Junction> ) -> Result<Location, (Location, Junction)>

pub fn at(&self, i: usize) -> Option<&Junction>

pub fn at_mut(&mut self, i: usize) -> Option<&mut Junction>

pub fn dec_parent(&mut self)

pub fn take_first_interior(&mut self) -> Option<Junction>

pub fn take_last(&mut self) -> Option<Junction>

pub fn match_and_split(&self, prefix: &Location) -> Option<&Junction>

§Example

pub fn starts_with(&self, prefix: &Location) -> bool

pub fn append_with( &mut self, suffix: impl Into<Location> ) -> Result<(), Location>

§Example

pub fn appended_with( self, suffix: impl Into<Location> ) -> Result<Location, (Location, Location)>

§Example

pub fn prepend_with( &mut self, prefix: impl Into<Location> ) -> Result<(), Location>

§Example

pub fn prepended_with( self, prefix: impl Into<Location> ) -> Result<Location, (Location, Location)>

§Example

pub fn simplify(&mut self, context: &Junctions)

pub fn chain_location(&self) -> Location

Trait Implementations§

impl Clone for Location

fn clone(&self) -> Location

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

impl<ParaId: IsSystem + From<u32>> Contains<Location> for IsChildSystemParachain<ParaId>

fn contains(l: &Location) -> bool

impl<Count: Get<u8>> Contains<Location> for IsParentsOnly<Count>

fn contains(t: &Location) -> bool

impl<ParaId: IsSystem + From<u32> + Eq, SelfParaId: Get<ParaId>> Contains<Location> for IsSiblingSystemParachain<ParaId, SelfParaId>

fn contains(l: &Location) -> bool

impl<T: Get<NetworkId>> Contains<Location> for StartsWithExplicitGlobalConsensus<T>

fn contains(location: &Location) -> bool

impl<T: Get<(AssetFilter, Location)>> ContainsPair<Asset, Location> for Case<T>

fn contains(asset: &Asset, origin: &Location) -> bool

impl ContainsPair<Asset, Location> for NativeAsset

fn contains(asset: &Asset, origin: &Location) -> bool

impl<Prefix: Contains<Location>> ContainsPair<Location, Location> for AliasForeignAccountId32<Prefix>

fn contains(origin: &Location, target: &Location) -> bool

impl Debug for Location

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

impl Decode for Location

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Location, Error>where __CodecInputEdqy: Input,

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>where I: Input,

fn skip<I>(input: &mut I) -> Result<(), Error>where I: Input,

fn encoded_fixed_size() -> Option<usize>

impl Default for Location

fn default() -> Location

impl<'de> Deserialize<'de> for Location

fn deserialize<__D>( __deserializer: __D ) -> Result<Location, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

impl Encode for Location

fn size_hint(&self) -> usize

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )where __CodecOutputEdqy: Output + ?Sized,

fn encode(&self) -> Vec<u8> ⓘ

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

fn encoded_size(&self) -> usize

impl From<[Junction; 0]> for Location

fn from(j: [Junction; 0]) -> Location

fn decode<CodecInputEdqy>( codec_input_edqy: &mut CodecInputEdqy ) -> Result<Location, Error>
where CodecInputEdqy: Input,

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>
where I: Input,

fn skip<I>(input: &mut I) -> Result<(), Error>
where I: Input,

fn deserialize<D>( deserializer: D ) -> Result<Location, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

fn encode_to<CodecOutputEdqy>( &self, codec_dest_edqy: &mut CodecOutputEdqy )
where CodecOutputEdqy: Output + ?Sized,

fn using_encoded<R, F>(&self, f: F) -> R
where F: FnOnce(&[u8]) -> R,

impl<J0> From<(Ancestor, J0)> for Location
where J0: Into<Junction>,

impl<J0, J1> From<(Ancestor, J0, J1)> for Location
where J0: Into<Junction>, J1: Into<Junction>,

impl<J0, J1, J2> From<(Ancestor, J0, J1, J2)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>,

impl<J0, J1, J2, J3> From<(Ancestor, J0, J1, J2, J3)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>,

impl<J0, J1, J2, J3, J4> From<(Ancestor, J0, J1, J2, J3, J4)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>,

impl<J0, J1, J2, J3, J4, J5> From<(Ancestor, J0, J1, J2, J3, J4, J5)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>, J5: Into<Junction>,

impl<J0, J1, J2, J3, J4, J5, J6> From<(Ancestor, J0, J1, J2, J3, J4, J5, J6)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>, J5: Into<Junction>, J6: Into<Junction>,

impl<J0, J1, J2, J3, J4, J5, J6, J7> From<(Ancestor, J0, J1, J2, J3, J4, J5, J6, J7)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>, J5: Into<Junction>, J6: Into<Junction>, J7: Into<Junction>,

impl<J0> From<(J0,)> for Location
where J0: Into<Junction>,

impl<J0, J1> From<(J0, J1)> for Location
where J0: Into<Junction>, J1: Into<Junction>,

impl<J0, J1, J2> From<(J0, J1, J2)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>,

impl<J0, J1, J2, J3> From<(J0, J1, J2, J3)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>,

impl<J0, J1, J2, J3, J4> From<(J0, J1, J2, J3, J4)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>,

impl<J0, J1, J2, J3, J4, J5> From<(J0, J1, J2, J3, J4, J5)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>, J5: Into<Junction>,

impl<J0, J1, J2, J3, J4, J5, J6> From<(J0, J1, J2, J3, J4, J5, J6)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>, J5: Into<Junction>, J6: Into<Junction>,

impl<J0, J1, J2, J3, J4, J5, J6, J7> From<(J0, J1, J2, J3, J4, J5, J6, J7)> for Location
where J0: Into<Junction>, J1: Into<Junction>, J2: Into<Junction>, J3: Into<Junction>, J4: Into<Junction>, J5: Into<Junction>, J6: Into<Junction>, J7: Into<Junction>,

impl<J0> From<(Parent, J0)> for Location
where J0: Into<Junction>,

impl<J0, J1> From<(Parent, J0, J1)> for Location
where J0: Into<Junction>, J1: Into<Junction>,