Trait scrypto_test::prelude::rust::ops::Index

pub trait Index<Idx>
where
    Idx: ?Sized,
{
    type Output: ?Sized;

    // Required method
    fn index(&self, index: Idx) -> &Self::Output;
}

Used for indexing operations (container[index]) in immutable contexts.

container[index] is actually syntactic sugar for *container.index(index), but only when used as an immutable value. If a mutable value is requested, IndexMut is used instead. This allows nice things such as let value = v[index] if the type of value implements Copy.

Examples

The following example implements Index on a read-only NucleotideCount container, enabling individual counts to be retrieved with index syntax.

use std::ops::Index;

enum Nucleotide {
    A,
    C,
    G,
    T,
}

struct NucleotideCount {
    a: usize,
    c: usize,
    g: usize,
    t: usize,
}

impl Index<Nucleotide> for NucleotideCount {
    type Output = usize;

    fn index(&self, nucleotide: Nucleotide) -> &Self::Output {
        match nucleotide {
            Nucleotide::A => &self.a,
            Nucleotide::C => &self.c,
            Nucleotide::G => &self.g,
            Nucleotide::T => &self.t,
        }
    }
}

let nucleotide_count = NucleotideCount {a: 14, c: 9, g: 10, t: 12};
assert_eq!(nucleotide_count[Nucleotide::A], 14);
assert_eq!(nucleotide_count[Nucleotide::C], 9);
assert_eq!(nucleotide_count[Nucleotide::G], 10);
assert_eq!(nucleotide_count[Nucleotide::T], 12);

Required Associated Types

type Output: ?Sized

The returned type after indexing.

Required Methods

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

Performs the indexing (container[index]) operation.

Panics

May panic if the index is out of bounds.

Implementors

impl Index<usize> for curve25519_dalek::scalar::Scalar

type Output = u8

impl Index<usize> for BStr

type Output = u8

impl Index<usize> for Bytes

type Output = u8

impl Index<Span> for str

type Output = str

impl Index<Span> for [u8]

type Output = [u8]

impl Index<Range<usize>> for BStr

type Output = BStr

impl Index<Range<usize>> for Bytes

type Output = Bytes

impl Index<RangeFrom<usize>> for CStr

type Output = CStr

impl Index<RangeFrom<usize>> for BStr

type Output = BStr

impl Index<RangeFrom<usize>> for Bytes

type Output = Bytes

impl Index<RangeFull> for CString

type Output = CStr

impl Index<RangeFull> for OsString

type Output = OsStr

impl Index<RangeFull> for BStr

type Output = BStr

impl Index<RangeFull> for Bytes

type Output = Bytes

impl Index<RangeInclusive<usize>> for BStr

type Output = BStr

impl Index<RangeInclusive<usize>> for Bytes

type Output = Bytes

impl Index<RangeTo<usize>> for BStr

type Output = BStr

impl Index<RangeTo<usize>> for Bytes

type Output = Bytes

impl Index<RangeToInclusive<usize>> for BStr

type Output = BStr

impl Index<RangeToInclusive<usize>> for Bytes

type Output = Bytes

impl<'a, K, Q, V> Index<&'a Q> for indexmap_nostd::map::IndexMap<K, V>

where K: Borrow<Q> + Ord, Q: Ord,

type Output = V

impl<'a, K, V> Index<usize> for Keys<'a, K, V>

Access IndexMap keys at indexed positions.

While Index<usize> for IndexMap accesses a map’s values, indexing through IndexMap::keys offers an alternative to access a map’s keys instead.

Since Keys is also an iterator, consuming items from the iterator will offset the effective indexes. Similarly, if Keys is obtained from Slice::keys, indexes will be interpreted relative to the position of that slice.

Examples

use indexmap::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}

assert_eq!(map[0], "LOREM");
assert_eq!(map.keys()[0], "lorem");
assert_eq!(map[1], "IPSUM");
assert_eq!(map.keys()[1], "ipsum");

map.reverse();
assert_eq!(map.keys()[0], "amet");
assert_eq!(map.keys()[1], "sit");

map.sort_keys();
assert_eq!(map.keys()[0], "amet");
assert_eq!(map.keys()[1], "dolor");

// Advancing the iterator will offset the indexing
let mut keys = map.keys();
assert_eq!(keys[0], "amet");
assert_eq!(keys.next().map(|s| &**s), Some("amet"));
assert_eq!(keys[0], "dolor");
assert_eq!(keys[1], "ipsum");

// Slices may have an offset as well
let slice = &map[2..];
assert_eq!(slice[0], "IPSUM");
assert_eq!(slice.keys()[0], "ipsum");

use indexmap::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map.keys()[10]); // panics!

type Output = K

impl<'a, Q> Index<&'a Q> for serde_json::map::Map<String, Value>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Access an element of this map. Panics if the given key is not present in the map.

match val {
    Value::String(s) => Some(s.as_str()),
    Value::Array(arr) => arr[0].as_str(),
    Value::Object(map) => map["type"].as_str(),
    _ => None,
}

type Output = Value

impl<'a, Q> Index<&'a Q> for toml::map::Map<String, Value>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Access an element of this map. Panics if the given key is not present in the map.

type Output = Value

impl<'h> Index<usize> for regex::regex::bytes::Captures<'h>

Get a matching capture group’s haystack substring by index.

The haystack substring returned can’t outlive the Captures object if this method is used, because of how Index is defined (normally a[i] is part of a and can’t outlive it). To work around this limitation, do that, use Captures::get instead.

'h is the lifetime of the matched haystack, but the lifetime of the &str returned by this implementation is the lifetime of the Captures value itself.

Panics

If there is no matching group at the given index.

type Output = [u8]

impl<'h> Index<usize> for regex::regex::string::Captures<'h>

Get a matching capture group’s haystack substring by index.

The haystack substring returned can’t outlive the Captures object if this method is used, because of how Index is defined (normally a[i] is part of a and can’t outlive it). To work around this limitation, do that, use Captures::get instead.

'h is the lifetime of the matched haystack, but the lifetime of the &str returned by this implementation is the lifetime of the Captures value itself.

Panics

If there is no matching group at the given index.

type Output = str

impl<'h, 'n> Index<&'n str> for regex::regex::bytes::Captures<'h>

Get a matching capture group’s haystack substring by name.

The haystack substring returned can’t outlive the Captures object if this method is used, because of how Index is defined (normally a[i] is part of a and can’t outlive it). To work around this limitation, do that, use Captures::get instead.

'h is the lifetime of the matched haystack, but the lifetime of the &str returned by this implementation is the lifetime of the Captures value itself.

'n is the lifetime of the group name used to index the Captures value.

Panics

If there is no matching group at the given name.

type Output = [u8]

impl<'h, 'n> Index<&'n str> for regex::regex::string::Captures<'h>

Get a matching capture group’s haystack substring by name.

The haystack substring returned can’t outlive the Captures object if this method is used, because of how Index is defined (normally a[i] is part of a and can’t outlive it). To work around this limitation, do that, use Captures::get instead.

'h is the lifetime of the matched haystack, but the lifetime of the &str returned by this implementation is the lifetime of the Captures value itself.

'n is the lifetime of the group name used to index the Captures value.

Panics

If there is no matching group at the given name.

type Output = str

impl<'s> Index<&'s str> for Document

type Output = Item

impl<'s> Index<&'s str> for InlineTable

type Output = Value

impl<'s> Index<&'s str> for Table

type Output = Item

impl<A, I> Index<I> for SmallVec<A>

where A: Array, I: SliceIndex<[<A as Array>::Item]>,

type Output = <I as SliceIndex<[<A as Array>::Item]>>::Output

impl<I> Index<I> for serde_json::value::Value

where I: Index,

type Output = Value

impl<I> Index<I> for toml::value::Value

where I: Index,

type Output = Value

impl<I> Index<I> for Item

where I: Index,

type Output = Item

impl<I> Index<I> for str

where I: SliceIndex<str>,

type Output = <I as SliceIndex<str>>::Output

impl<I> Index<I> for String

where I: SliceIndex<str>,

type Output = <I as SliceIndex<str>>::Output

impl<I> Index<I> for p1_affines

where I: SliceIndex<[blst_p1_affine]>,

type Output = <I as SliceIndex<[blst_p1_affine]>>::Output

impl<I> Index<I> for p2_affines

where I: SliceIndex<[blst_p2_affine]>,

type Output = <I as SliceIndex<[blst_p2_affine]>>::Output

impl<I> Index<I> for RecoverableSignature

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for ElligatorSwift

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for Keypair

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for PublicKey

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for secp256k1_sys::Signature

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for XOnlyPublicKey

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for SecretKey

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for secp256k1::scalar::Scalar

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for secp256k1::schnorr::Signature

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I> Index<I> for Message

where [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

impl<I, T, const N: usize> Index<I> for Simd<T, N>

where T: SimdElement, LaneCount<N>: SupportedLaneCount, I: SliceIndex<[T]>,

type Output = <I as SliceIndex<[T]>>::Output

impl<Idx, T> Index<Idx> for ComponentVec<Idx, T>

where Idx: ArenaIndex,

type Output = T

impl<Idx, T> Index<Idx> for DedupArena<Idx, T>

where Idx: ArenaIndex,

type Output = T

impl<Idx, T> Index<Idx> for Arena<Idx, T>

where Idx: ArenaIndex,

type Output = T

impl<K, Q, V, A> Index<&Q> for BTreeMap<K, V, A>

where A: Allocator + Clone, K: Borrow<Q> + Ord, Q: Ord + ?Sized,

type Output = V

impl<K, Q, V, S> Index<&Q> for scrypto_test::prelude::rust::prelude::hash_map::ext_HashMap<K, V, S>

where K: Eq + Hash + Borrow<Q>, Q: Eq + Hash + ?Sized, S: BuildHasher,

type Output = V

impl<K, Q, V, S, A> Index<&Q> for hashbrown::map::HashMap<K, V, S, A>

where K: Eq + Hash + Borrow<Q>, Q: Eq + Hash + ?Sized, S: BuildHasher, A: Allocator + Clone,

type Output = V

impl<K, Q, V, S, A> Index<&Q> for hashbrown::map::HashMap<K, V, S, A>

where K: Eq + Hash, Q: Hash + Equivalent<K> + ?Sized, S: BuildHasher, A: Allocator,

type Output = V

impl<K, V> Index<(Bound<usize>, Bound<usize>)> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V> Index<usize> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = V

impl<K, V> Index<usize> for indexmap_nostd::map::IndexMap<K, V>

type Output = V

impl<K, V> Index<Range<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V> Index<RangeFrom<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V> Index<RangeFull> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V> Index<RangeInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V> Index<RangeTo<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V> Index<RangeToInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::map::Slice<K, V>

type Output = Slice<K, V>

impl<K, V, Q, S> Index<&Q> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

where Q: Hash + Equivalent<K> + ?Sized, S: BuildHasher,

Access IndexMap values corresponding to a key.

Examples

use indexmap::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map["lorem"], "LOREM");
assert_eq!(map["ipsum"], "IPSUM");

use indexmap::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map["bar"]); // panics!

type Output = V

impl<K, V, Q, S> Index<&Q> for indexmap::map::IndexMap<K, V, S>

where Q: Hash + Equivalent<K> + ?Sized, K: Hash + Eq, S: BuildHasher,

Access IndexMap values corresponding to a key.

Examples

use indexmap::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map["lorem"], "LOREM");
assert_eq!(map["ipsum"], "IPSUM");

use indexmap::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map["bar"]); // panics!

type Output = V

impl<K, V, S> Index<(Bound<usize>, Bound<usize>)> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<K, V, S> Index<usize> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

Access IndexMap values at indexed positions.

See Index<usize> for Keys to access a map’s keys instead.

Examples

use indexmap::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map[0], "LOREM");
assert_eq!(map[1], "IPSUM");
map.reverse();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "SIT");
map.sort_keys();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "DOLOR");

use indexmap::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map[10]); // panics!

type Output = V

impl<K, V, S> Index<usize> for indexmap::map::IndexMap<K, V, S>

Access IndexMap values at indexed positions.

Examples

use indexmap::IndexMap;

let mut map = IndexMap::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    map.insert(word.to_lowercase(), word.to_uppercase());
}
assert_eq!(map[0], "LOREM");
assert_eq!(map[1], "IPSUM");
map.reverse();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "SIT");
map.sort_keys();
assert_eq!(map[0], "AMET");
assert_eq!(map[1], "DOLOR");

use indexmap::IndexMap;

let mut map = IndexMap::new();
map.insert("foo", 1);
println!("{:?}", map[10]); // panics!

type Output = V

impl<K, V, S> Index<Range<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<K, V, S> Index<RangeFrom<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<K, V, S> Index<RangeFull> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<K, V, S> Index<RangeInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<K, V, S> Index<RangeTo<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<K, V, S> Index<RangeToInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexMap<K, V, S>

type Output = Slice<K, V>

impl<T> Index<(Bound<usize>, Bound<usize>)> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T> Index<usize> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = T

impl<T> Index<usize> for indexmap_nostd::set::IndexSet<T>

type Output = T

impl<T> Index<PatternID> for [T]

type Output = T

impl<T> Index<PatternID> for Vec<T>

type Output = T

impl<T> Index<SmallIndex> for [T]

type Output = T

impl<T> Index<SmallIndex> for Vec<T>

type Output = T

impl<T> Index<StateID> for [T]

type Output = T

impl<T> Index<StateID> for Vec<T>

type Output = T

impl<T> Index<Range<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T> Index<RangeFrom<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T> Index<RangeFull> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T> Index<RangeInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T> Index<RangeTo<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T> Index<RangeToInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::set::Slice<T>

type Output = Slice<T>

impl<T, A> Index<usize> for VecDeque<T, A>

where A: Allocator,

type Output = T

impl<T, I> Index<I> for [T]

where I: SliceIndex<[T]>,

type Output = <I as SliceIndex<[T]>>::Output

impl<T, I, A> Index<I> for Vec<T, A>

where I: SliceIndex<[T]>, A: Allocator,

type Output = <I as SliceIndex<[T]>>::Output

impl<T, I, const N: usize> Index<I> for [T; N]

where [T]: Index<I>,

type Output = <[T] as Index<I>>::Output

impl<T, P> Index<usize> for Punctuated<T, P>

type Output = T

impl<T, S> Index<(Bound<usize>, Bound<usize>)> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>

impl<T, S> Index<usize> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

Access IndexSet values at indexed positions.

Examples

use indexmap::IndexSet;

let mut set = IndexSet::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    set.insert(word.to_string());
}
assert_eq!(set[0], "Lorem");
assert_eq!(set[1], "ipsum");
set.reverse();
assert_eq!(set[0], "amet");
assert_eq!(set[1], "sit");
set.sort();
assert_eq!(set[0], "Lorem");
assert_eq!(set[1], "amet");

use indexmap::IndexSet;

let mut set = IndexSet::new();
set.insert("foo");
println!("{:?}", set[10]); // panics!

type Output = T

impl<T, S> Index<usize> for indexmap::set::IndexSet<T, S>

Access IndexSet values at indexed positions.

Examples

use indexmap::IndexSet;

let mut set = IndexSet::new();
for word in "Lorem ipsum dolor sit amet".split_whitespace() {
    set.insert(word.to_string());
}
assert_eq!(set[0], "Lorem");
assert_eq!(set[1], "ipsum");
set.reverse();
assert_eq!(set[0], "amet");
assert_eq!(set[1], "sit");
set.sort();
assert_eq!(set[0], "Lorem");
assert_eq!(set[1], "amet");

use indexmap::IndexSet;

let mut set = IndexSet::new();
set.insert("foo");
println!("{:?}", set[10]); // panics!

type Output = T

impl<T, S> Index<Range<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>

impl<T, S> Index<RangeFrom<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>

impl<T, S> Index<RangeFull> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>

impl<T, S> Index<RangeInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>

impl<T, S> Index<RangeTo<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>

impl<T, S> Index<RangeToInclusive<usize>> for scrypto_test::prelude::rust::prelude::index_map::indexmap::IndexSet<T, S>

type Output = Slice<T>