class OptionIter

Declaration

template <class ItemT>
class OptionIter { /* full declaration omitted */ };

Description

An iterator over the element from an [`Option`]($sus::option::Option). This type is returned from [`Option::iter`]($sus::option::Option::iter), [`Option::iter_mut`]($sus::option::Option::iter_mut) and [`Option::into_iter`]($sus::option::Option::into_iter), as well as [`Result::iter`]($sus::result::Result::iter), [`Result::iter_mut`]($sus::result::Result::iter_mut) and [`Result::into_iter`]($sus::result::Result::into_iter).

Declared at: sus/option/option_iter.h:35

Templates

ItemT

Method Overview

  • public OptionIter<Item>(OptionIter<Item> &&)
  • public constexpr OptionIter<Item> clone() const noexcept
  • public constexpr sus::num::usize exact_size_hint() const noexcept
  • public constexpr Option<sus::option::OptionIter::Item> next() noexcept
  • public constexpr Option<sus::option::OptionIter::Item> next_back() noexcept
  • public constexpr ::sus::iter::SizeHint size_hint() const noexcept
  • public constexpr ::sus::iter::__private::TrustedLenMarker trusted_len() const noexcept

Methods

OptionIter<Item>(OptionIter<Item>&&)

Declared at: sus/option/option_iter.h:41

Parameters

OptionIter<Item>&&

constexpr OptionIter<Item> clone() const noexcept

Declared at: sus/option/option_iter.h:45

constexpr sus::num::usize exact_size_hint()
    const noexcept

Description

[`ExactSizeIterator`]($sus::iter::ExactSizeIterator) trait.

Declared at: sus/option/option_iter.h:61

constexpr Option<sus::option::OptionIter::Item>
next() noexcept

Declared at: sus/option/option_iter.h:52

constexpr Option<sus::option::OptionIter::Item>
next_back() noexcept

Description

[`DoubleEndedIterator`]($sus::iter::DoubleEndedIterator) trait.

Declared at: sus/option/option_iter.h:59

constexpr ::sus::iter::SizeHint size_hint()
    const noexcept

Description

[`Iterator`]($sus::iter::Iterator) trait.

Declared at: sus/option/option_iter.h:54

constexpr ::sus::iter::__private::TrustedLenMarker
trusted_len() const noexcept

Description

[`TrustedLen`]($sus::iter::TrustedLen) trait. #[doc.hidden]

Declared at: sus/option/option_iter.h:66