Struct ssh_cfg::SshConfig [−][src]
pub struct SshConfig(pub IndexMap<String, SshHostConfig>);
Expand description
Parsed SSH config file.
Tuple Fields
0: IndexMap<String, SshHostConfig>
Methods from Deref<Target = IndexMap<String, SshHostConfig>>
Return the number of key-value pairs in the map.
Computes in O(1) time.
Returns true if the map contains no elements.
Computes in O(1) time.
Return an iterator over the key-value pairs of the map, in their order
Return an iterator over the key-value pairs of the map, in their order
Return an iterator over the keys of the map, in their order
Return an iterator over the values of the map, in their order
Return an iterator over mutable references to the values of the map, in their order
Remove all key-value pairs in the map, while preserving its capacity.
Computes in O(n) time.
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.
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.
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
.
Reserve capacity for additional
more key-value pairs.
Computes in O(n) time.
Shrink the capacity of the map as much as possible.
Computes in O(n) time.
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.
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.
Get the given key’s corresponding entry in the map for insertion and/or in-place manipulation.
Computes in O(1) time (amortized average).
Return true
if an equivalent to key
exists in the map.
Computes in O(1) time (average).
Return a reference to the value stored for key
, if it is present,
else None
.
Computes in O(1) time (average).
Return references to the key-value pair stored for key
,
if it is present, else None
.
Computes in O(1) time (average).
Return item index, key and value
pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize> where
Q: Hash + Equivalent<K> + ?Sized,
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_full_mut<Q>(&mut self, key: &Q) -> Option<(usize, &K, &mut 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,
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).
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,
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,
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,
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,
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,
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).
Remove the last key-value pair
Computes in O(1) time (average).
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).
Sort the map’s key-value pairs by the default ordering of the keys.
See sort_by
for details.
Sort the map’s key-value pairs in place using the comparison
function compare
.
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.
Get a key-value pair by index
Valid indices are 0 <= index < self.len()
Computes in O(1) time.
Get a key-value pair by index
Valid indices are 0 <= index < self.len()
Computes in O(1) time.
Get the first key-value pair, with mutable access to the value
Computes in O(1) time.
Get the last key-value pair, with mutable access to the value
Computes in O(1) time.
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).
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).
Swaps the position of two key-value pairs in the map.
Panics if a
or b
are out of bounds.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for SshConfig
impl UnwindSafe for SshConfig
Blanket Implementations
Mutably borrows from an owned value. Read more