Struct Groups

pub struct Groups(/* private fields */);

Collection of named groups.

Implementations

impl Groups

pub const fn new() -> Self

Constructs a new, empty Groups.

pub fn insert( &mut self, name: Group, urefs: BTreeSet<URef>, ) -> Option<BTreeSet<URef>>

Inserts a named group.

If the map did not have this name present, None is returned. If the map did have this name present, its collection of URefs is overwritten, and the collection is returned.

pub fn contains(&self, name: &Group) -> bool

Returns true if the named group exists in the collection.

pub fn get(&self, name: &Group) -> Option<&BTreeSet<URef>>

Returns a reference to the collection of URefs under the given name if any.

pub fn get_mut(&mut self, name: &Group) -> Option<&mut BTreeSet<URef>>

Returns a mutable reference to the collection of URefs under the given name if any.

pub fn len(&self) -> usize

Returns the number of named groups.

pub fn is_empty(&self) -> bool

Returns true if there are no named groups.

pub fn keys(&self) -> impl Iterator<Item = &BTreeSet<URef>>

Returns an iterator over the Keys (i.e. the map’s values).

pub fn total_urefs(&self) -> usize

Returns the total number of URefs contained in all the groups.

Trait Implementations

impl Clone for Groups

fn clone(&self) -> Groups

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for Groups

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for Groups

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

Formats the value using the given formatter.

impl Default for Groups

fn default() -> Groups

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Groups

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BTreeMap<Group, BTreeSet<URef>>> for Groups

Available on crate features testing or gens only.

fn from(value: BTreeMap<Group, BTreeSet<URef>>) -> Self

Converts to this type from the input type.

impl FromBytes for Groups

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl JsonSchema for Groups

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl PartialEq for Groups

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Groups

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for Groups

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl Eq for Groups

impl StructuralPartialEq for Groups