Struct fhirbolt_element::Element

pub struct Element<const R: FhirRelease> { /* private fields */ }

Generic element in a FHIR resource.

As deserialization differs slightly between FHIR releases, Element is generic over a FHIR release.

It is recommended to use the Element! macro for creating new element.

Example

With macro

use fhirbolt::FhirReleases;
use fhirbolt::element::{Element, Value, Primitive};

let element: Element<{ FhirReleases::R4 }> = Element! {
    "value" => Value::Primitive(Primitive::String("123".into())),
};

Without macro

use fhirbolt::FhirReleases;
use fhirbolt::element::{Element, Value, Primitive};

let mut element = Element::<{ FhirReleases:: R4B }>::new();
element.insert(
    "value".to_string(),
    Value::Primitive(
        Primitive::String("123".to_string())
    )
);
// ...

Implementations

impl<const R: FhirRelease> Element<R>

pub fn new() -> Self

Create a new element.

pub fn with_capacity(n: usize) -> Self

Create a new element wit preallocated capacity.

Methods from Deref<Target = IndexMap<String, Value<R>>>

pub fn capacity(&self) -> usize

Computes in O(1) time.

pub fn hasher(&self) -> &S

Return a reference to the map’s BuildHasher.

pub fn len(&self) -> usize

Return the number of key-value pairs in the map.

Computes in O(1) time.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Computes in O(1) time.

pub fn iter(&self) -> Iter<'_, K, V>

Return an iterator over the key-value pairs of the map, in their order

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

Return an iterator over the key-value pairs of the map, in their order

pub fn keys(&self) -> Keys<'_, K, V>

Return an iterator over the keys of the map, in their order

pub fn values(&self) -> Values<'_, K, V>

Return an iterator over the values of the map, in their order

pub fn values_mut(&mut self) -> ValuesMut<'_, K, V>

Return an iterator over mutable references to the values of the map, in their order

pub fn clear(&mut self)

Remove all key-value pairs in the map, while preserving its capacity.

Computes in O(n) time.

pub fn truncate(&mut self, len: usize)

Shortens the map, keeping the first len elements and dropping the rest.

If len is greater than the map’s current length, this has no effect.

pub fn drain<R>(&mut self, range: R) -> Drain<'_, K, V>where R: RangeBounds<usize>,

Clears the IndexMap in the given index range, returning those key-value pairs as a drain iterator.

The range may be any type that implements RangeBounds<usize>, including all of the std::ops::Range* types, or even a tuple pair of Bound start and end values. To drain the map entirely, use RangeFull like map.drain(..).

This shifts down all entries following the drained range to fill the gap, and keeps the allocated memory for reuse.

Panics if the starting point is greater than the end point or if the end point is greater than the length of the map.

pub fn split_off(&mut self, at: usize) -> IndexMap<K, V, S>where S: Clone,

Splits the collection into two at the given index.

Returns a newly allocated map containing the elements in the range [at, len). After the call, the original map will be left containing the elements [0, at) with its previous capacity unchanged.

Panics if at > len.

pub fn reserve(&mut self, additional: usize)

Reserve capacity for additional more key-value pairs.

Computes in O(n) time.

pub fn shrink_to_fit(&mut self)

Shrink the capacity of the map as much as possible.

Computes in O(n) time.

pub fn shrink_to(&mut self, min_capacity: usize)

Shrink the capacity of the map with a lower limit.

Computes in O(n) time.

pub fn insert(&mut self, key: K, value: V) -> Option<V>

Insert a key-value pair in the map.

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside Some(_).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and None is returned.

Computes in O(1) time (amortized average).

See also entry if you you want to insert or modify or if you need to get the index of the corresponding key-value pair.

pub fn insert_full(&mut self, key: K, value: V) -> (usize, Option<V>)

Insert a key-value pair in the map, and get their index.

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside (index, Some(_)).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and (index, None) is returned.

Computes in O(1) time (amortized average).

See also entry if you you want to insert or modify or if you need to get the index of the corresponding key-value pair.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

Get the given key’s corresponding entry in the map for insertion and/or in-place manipulation.

Computes in O(1) time (amortized average).

pub fn contains_key<Q>(&self, key: &Q) -> boolwhere Q: Hash + Equivalent<K> + ?Sized,

Return true if an equivalent to key exists in the map.

Computes in O(1) time (average).

pub fn get<Q>(&self, key: &Q) -> Option<&V>where Q: Hash + Equivalent<K> + ?Sized,

Return a reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>where Q: Hash + Equivalent<K> + ?Sized,

Return references to the key-value pair stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn get_full<Q>(&self, key: &Q) -> Option<(usize, &K, &V)>where Q: Hash + Equivalent<K> + ?Sized,

Return item index, key and value

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize>where Q: Hash + Equivalent<K> + ?Sized,

Return item index, if it exists in the map

Computes in O(1) time (average).

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>where Q: Hash + Equivalent<K> + ?Sized,

pub fn get_full_mut<Q>(&mut self, key: &Q) -> Option<(usize, &K, &mut V)>where Q: Hash + Equivalent<K> + ?Sized,

pub fn remove<Q>(&mut self, key: &Q) -> Option<V>where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return its value.

NOTE: This is equivalent to .swap_remove(key), if you need to preserve the order of the keys in the map, use .shift_remove(key) instead.

Computes in O(1) time (average).

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>where Q: Hash + Equivalent<K> + ?Sized,

Remove and return the key-value pair equivalent to key.

NOTE: This is equivalent to .swap_remove_entry(key), if you need to preserve the order of the keys in the map, use .shift_remove_entry(key) instead.

Computes in O(1) time (average).

pub fn swap_remove<Q>(&mut self, key: &Q) -> Option<V>where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return its value.

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Return None if key is not in map.

Computes in O(1) time (average).

pub fn swap_remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>where Q: Hash + Equivalent<K> + ?Sized,

Remove and return the key-value pair equivalent to key.

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Return None if key is not in map.

Computes in O(1) time (average).

pub fn swap_remove_full<Q>(&mut self, key: &Q) -> Option<(usize, K, V)>where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return it and the index it had.

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Return None if key is not in map.

Computes in O(1) time (average).

pub fn shift_remove<Q>(&mut self, key: &Q) -> Option<V>where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return its value.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

pub fn shift_remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>where Q: Hash + Equivalent<K> + ?Sized,

Remove and return the key-value pair equivalent to key.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

pub fn shift_remove_full<Q>(&mut self, key: &Q) -> Option<(usize, K, V)>where Q: Hash + Equivalent<K> + ?Sized,

Remove the key-value pair equivalent to key and return it and the index it had.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

pub fn pop(&mut self) -> Option<(K, V)>

Remove the last key-value pair

This preserves the order of the remaining elements.

Computes in O(1) time (average).

pub fn retain<F>(&mut self, keep: F)where F: FnMut(&K, &mut V) -> bool,

Scan through each key-value pair in the map and keep those where the closure keep returns true.

The elements are visited in order, and remaining elements keep their order.

Computes in O(n) time (average).

pub fn sort_keys(&mut self)where K: Ord,

Sort the map’s key-value pairs by the default ordering of the keys.

See sort_by for details.

pub fn sort_by<F>(&mut self, cmp: F)where F: FnMut(&K, &V, &K, &V) -> Ordering,

Sort the map’s key-value pairs in place using the comparison function cmp.

The comparison function receives two key and value pairs to compare (you can sort by keys or values or their combination as needed).

Computes in O(n log n + c) time and O(n) space where n is the length of the map and c the capacity. The sort is stable.

pub fn sort_unstable_keys(&mut self)where K: Ord,

Sort the map’s key-value pairs by the default ordering of the keys, but may not preserve the order of equal elements.

See sort_unstable_by for details.

pub fn sort_unstable_by<F>(&mut self, cmp: F)where F: FnMut(&K, &V, &K, &V) -> Ordering,

Sort the map’s key-value pairs in place using the comparison function cmp, but may not preserve the order of equal elements.

The comparison function receives two key and value pairs to compare (you can sort by keys or values or their combination as needed).

Computes in O(n log n + c) time where n is the length of the map and c is the capacity. The sort is unstable.

pub fn reverse(&mut self)

Reverses the order of the map’s key-value pairs in place.

Computes in O(n) time and O(1) space.

pub fn get_index(&self, index: usize) -> Option<(&K, &V)>

Get a key-value pair by index

Valid indices are 0 <= index < self.len()

Computes in O(1) time.

pub fn get_index_mut(&mut self, index: usize) -> Option<(&mut K, &mut V)>

Get a key-value pair by index

Valid indices are 0 <= index < self.len()

Computes in O(1) time.

pub fn first(&self) -> Option<(&K, &V)>

Get the first key-value pair

Computes in O(1) time.

pub fn first_mut(&mut self) -> Option<(&K, &mut V)>

Get the first key-value pair, with mutable access to the value

Computes in O(1) time.

pub fn last(&self) -> Option<(&K, &V)>

Get the last key-value pair

Computes in O(1) time.

pub fn last_mut(&mut self) -> Option<(&K, &mut V)>

Get the last key-value pair, with mutable access to the value

Computes in O(1) time.

pub fn swap_remove_index(&mut self, index: usize) -> Option<(K, V)>

Remove the key-value pair by index

Valid indices are 0 <= index < self.len()

Like Vec::swap_remove, the pair is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

Computes in O(1) time (average).

pub fn shift_remove_index(&mut self, index: usize) -> Option<(K, V)>

Remove the key-value pair by index

Valid indices are 0 <= index < self.len()

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Computes in O(n) time (average).

pub fn move_index(&mut self, from: usize, to: usize)

Moves the position of a key-value pair from one index to another by shifting all other pairs in-between.

• If from < to, the other pairs will shift down while the targeted pair moves up.
• If from > to, the other pairs will shift up while the targeted pair moves down.

Panics if from or to are out of bounds.

Computes in O(n) time (average).

pub fn swap_indices(&mut self, a: usize, b: usize)

Swaps the position of two key-value pairs in the map.

Panics if a or b are out of bounds.

Trait Implementations

impl<const R: FhirRelease> Clone for Element<R>

fn clone(&self) -> Element<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const R: FhirRelease> Debug for Element<R>

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

Formats the value using the given formatter.

impl<const R: FhirRelease> Default for Element<R>

fn default() -> Element<R>

Returns the “default value” for a type.

impl<const R: FhirRelease> Deref for Element<R>

type Target = IndexMap<String, Value<R>, RandomState>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const R: FhirRelease> DerefMut for Element<R>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const R: FhirRelease, const N: usize> From<[(&str, Value<R>); N]> for Element<R>

fn from(arr: [(&str, Value<R>); N]) -> Self

Converts to this type from the input type.

impl<const R: FhirRelease, const N: usize> From<[(String, Value<R>); N]> for Element<R>

fn from(arr: [(String, Value<R>); N]) -> Self

Converts to this type from the input type.

impl<const R: FhirRelease> FromIterator<(String, Value<R>)> for Element<R>

fn from_iter<I: IntoIterator<Item = (String, Value<R>)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, const R: FhirRelease> IntoIterator for &'a Element<R>

type Item = (&'a String, &'a Value<R>)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, Value<R>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, const R: FhirRelease> IntoIterator for &'a mut Element<R>

type Item = (&'a String, &'a mut Value<R>)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, String, Value<R>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const R: FhirRelease> IntoIterator for Element<R>

type Item = (String, Value<R>)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, Value<R>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const R: FhirRelease> PartialEq<Element<R>> for Element<R>

fn eq(&self, other: &Element<R>) -> bool

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

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.

impl<const R: FhirRelease> StructuralPartialEq for Element<R>