Module `0x1::option`

This module defines the Option type and its methods to represent and handle an optional value.

Struct Option
Constants
Function none
Function some
Function is_none
Function is_some
Function contains
Function borrow
Function borrow_with_default
Function get_with_default
Function fill
Function extract
Function borrow_mut
Function swap
Function swap_or_fill
Function destroy_with_default
Function destroy_some
Function destroy_none
Function to_vec
Function for_each
Function for_each_ref
Function for_each_mut
Function fold
Function map
Function filter
Module Specification
- Helper Schema

<pre><code>use <a href="vector.md#0x1_vector">0x1::vector</a>; </code></pre>

Struct `Option`

Abstraction of a value that may or may not be present. Implemented with a vector of size zero or one because Move bytecode does not have ADTs.

<pre><code>struct <a href="option.md#0x1_option_Option">Option</a><Element> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>vec: <a href="vector.md#0x1_vector">vector</a><Element></code> </dt> <dd> </dd> </dl> </details> <details> <summary>Specification</summary>

The size of vector is always less than equal to 1 because it's 0 for "none" or 1 for "some".

<pre><code>invariant len(vec) <= 1; </code></pre> </details>

Constants

The <code><a href="option.md#0x1_option_Option">Option</a></code> is in an invalid state for the operation attempted. The <code><a href="option.md#0x1_option_Option">Option</a></code> is <code>Some</code> while it should be <code>None</code>.

<pre><code>const <a href="option.md#0x1_option_EOPTION_IS_SET">EOPTION_IS_SET</a>: u64 = 262144; </code></pre>

<pre><code>const <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>: u64 = 262145; </code></pre>

Function `none`

Return an empty <code><a href="option.md#0x1_option_Option">Option</a></code>

<pre><code>public fun <a href="option.md#0x1_option_none">none</a><Element>(): <a href="option.md#0x1_option_Option">option::Option</a><Element> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_none">none</a><Element>(): <a href="option.md#0x1_option_Option">Option</a><Element> { <a href="option.md#0x1_option_Option">Option</a> { vec: <a href="vector.md#0x1_vector_empty">vector::empty</a>() } } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == <a href="option.md#0x1_option_spec_none">spec_none</a><Element>(); </code></pre>

<pre><code>fun <a href="option.md#0x1_option_spec_none">spec_none</a><Element>(): <a href="option.md#0x1_option_Option">Option</a><Element> { <a href="option.md#0x1_option_Option">Option</a>{ vec: vec() } } </code></pre> </details>

Function `some`

Return an <code><a href="option.md#0x1_option_Option">Option</a></code> containing <code>e</code>

<pre><code>public fun <a href="option.md#0x1_option_some">some</a><Element>(e: Element): <a href="option.md#0x1_option_Option">option::Option</a><Element> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_some">some</a><Element>(e: Element): <a href="option.md#0x1_option_Option">Option</a><Element> { <a href="option.md#0x1_option_Option">Option</a> { vec: <a href="vector.md#0x1_vector_singleton">vector::singleton</a>(e) } } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == <a href="option.md#0x1_option_spec_some">spec_some</a>(e); </code></pre>

<pre><code>fun <a href="option.md#0x1_option_spec_some">spec_some</a><Element>(e: Element): <a href="option.md#0x1_option_Option">Option</a><Element> { <a href="option.md#0x1_option_Option">Option</a>{ vec: vec(e) } } </code></pre> </details>

Function `is_none`

Return true if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_is_none">is_none</a><Element>(t: &<a href="option.md#0x1_option_Option">option::Option</a><Element>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_is_none">is_none</a><Element>(t: &<a href="option.md#0x1_option_Option">Option</a><Element>): bool { <a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(&t.vec) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == <a href="option.md#0x1_option_is_none">is_none</a>(t); </code></pre> </details>

Function `is_some`

Return true if <code>t</code> holds a value

<pre><code>public fun <a href="option.md#0x1_option_is_some">is_some</a><Element>(t: &<a href="option.md#0x1_option_Option">option::Option</a><Element>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_is_some">is_some</a><Element>(t: &<a href="option.md#0x1_option_Option">Option</a><Element>): bool { !<a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(&t.vec) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == <a href="option.md#0x1_option_is_some">is_some</a>(t); </code></pre> </details>

Function `contains`

Return true if the value in <code>t</code> is equal to <code>e_ref</code> Always returns <code>false</code> if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_contains">contains</a><Element>(t: &<a href="option.md#0x1_option_Option">option::Option</a><Element>, e_ref: &Element): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_contains">contains</a><Element>(t: &<a href="option.md#0x1_option_Option">Option</a><Element>, e_ref: &Element): bool { <a href="vector.md#0x1_vector_contains">vector::contains</a>(&t.vec, e_ref) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == <a href="option.md#0x1_option_spec_contains">spec_contains</a>(t, e_ref); </code></pre>

<pre><code>fun <a href="option.md#0x1_option_spec_contains">spec_contains</a><Element>(t: <a href="option.md#0x1_option_Option">Option</a><Element>, e: Element): bool { <a href="option.md#0x1_option_is_some">is_some</a>(t) && <a href="option.md#0x1_option_borrow">borrow</a>(t) == e } </code></pre> </details>

Function `borrow`

Return an immutable reference to the value inside <code>t</code> Aborts if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_borrow">borrow</a><Element>(t: &<a href="option.md#0x1_option_Option">option::Option</a><Element>): &Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_borrow">borrow</a><Element>(t: &<a href="option.md#0x1_option_Option">Option</a><Element>): &Element { assert!(<a href="option.md#0x1_option_is_some">is_some</a>(t), <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>); <a href="vector.md#0x1_vector_borrow">vector::borrow</a>(&t.vec, 0) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="option.md#0x1_option_AbortsIfNone">AbortsIfNone</a><Element>; ensures result == <a href="option.md#0x1_option_borrow">borrow</a>(t); </code></pre> </details>

Function `borrow_with_default`

Return a reference to the value inside <code>t</code> if it holds one Return <code>default_ref</code> if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_borrow_with_default">borrow_with_default</a><Element>(t: &<a href="option.md#0x1_option_Option">option::Option</a><Element>, default_ref: &Element): &Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_borrow_with_default">borrow_with_default</a><Element>(t: &<a href="option.md#0x1_option_Option">Option</a><Element>, default_ref: &Element): &Element { let vec_ref = &t.vec; if (<a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(vec_ref)) default_ref else <a href="vector.md#0x1_vector_borrow">vector::borrow</a>(vec_ref, 0) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == (if (<a href="option.md#0x1_option_is_some">is_some</a>(t)) <a href="option.md#0x1_option_borrow">borrow</a>(t) else default_ref); </code></pre> </details>

Function `get_with_default`

Return the value inside <code>t</code> if it holds one Return <code>default</code> if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_get_with_default">get_with_default</a><Element: copy, drop>(t: &<a href="option.md#0x1_option_Option">option::Option</a><Element>, default: Element): Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_get_with_default">get_with_default</a><Element: copy + drop>( t: &<a href="option.md#0x1_option_Option">Option</a><Element>, default: Element, ): Element { let vec_ref = &t.vec; if (<a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(vec_ref)) default else *<a href="vector.md#0x1_vector_borrow">vector::borrow</a>(vec_ref, 0) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == (if (<a href="option.md#0x1_option_is_some">is_some</a>(t)) <a href="option.md#0x1_option_borrow">borrow</a>(t) else default); </code></pre> </details>

Function `fill`

Convert the none option <code>t</code> to a some option by adding <code>e</code>. Aborts if <code>t</code> already holds a value

<pre><code>public fun <a href="option.md#0x1_option_fill">fill</a><Element>(t: &mut <a href="option.md#0x1_option_Option">option::Option</a><Element>, e: Element) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_fill">fill</a><Element>(t: &mut <a href="option.md#0x1_option_Option">Option</a><Element>, e: Element) { let vec_ref = &mut t.vec; if (<a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(vec_ref)) <a href="vector.md#0x1_vector_push_back">vector::push_back</a>(vec_ref, e) else abort <a href="option.md#0x1_option_EOPTION_IS_SET">EOPTION_IS_SET</a> } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if <a href="option.md#0x1_option_is_some">is_some</a>(t) with <a href="option.md#0x1_option_EOPTION_IS_SET">EOPTION_IS_SET</a>; ensures <a href="option.md#0x1_option_is_some">is_some</a>(t); ensures <a href="option.md#0x1_option_borrow">borrow</a>(t) == e; </code></pre> </details>

Function `extract`

Convert a <code>some</code> option to a <code>none</code> by removing and returning the value stored inside <code>t</code> Aborts if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_extract">extract</a><Element>(t: &mut <a href="option.md#0x1_option_Option">option::Option</a><Element>): Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_extract">extract</a><Element>(t: &mut <a href="option.md#0x1_option_Option">Option</a><Element>): Element { assert!(<a href="option.md#0x1_option_is_some">is_some</a>(t), <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>); <a href="vector.md#0x1_vector_pop_back">vector::pop_back</a>(&mut t.vec) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="option.md#0x1_option_AbortsIfNone">AbortsIfNone</a><Element>; ensures result == <a href="option.md#0x1_option_borrow">borrow</a>(old(t)); ensures <a href="option.md#0x1_option_is_none">is_none</a>(t); </code></pre> </details>

Function `borrow_mut`

Return a mutable reference to the value inside <code>t</code> Aborts if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_borrow_mut">borrow_mut</a><Element>(t: &mut <a href="option.md#0x1_option_Option">option::Option</a><Element>): &mut Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_borrow_mut">borrow_mut</a><Element>(t: &mut <a href="option.md#0x1_option_Option">Option</a><Element>): &mut Element { assert!(<a href="option.md#0x1_option_is_some">is_some</a>(t), <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>); <a href="vector.md#0x1_vector_borrow_mut">vector::borrow_mut</a>(&mut t.vec, 0) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="option.md#0x1_option_AbortsIfNone">AbortsIfNone</a><Element>; ensures result == <a href="option.md#0x1_option_borrow">borrow</a>(t); ensures t == old(t); </code></pre> </details>

Function `swap`

Swap the old value inside <code>t</code> with <code>e</code> and return the old value Aborts if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_swap">swap</a><Element>(t: &mut <a href="option.md#0x1_option_Option">option::Option</a><Element>, e: Element): Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_swap">swap</a><Element>(t: &mut <a href="option.md#0x1_option_Option">Option</a><Element>, e: Element): Element { assert!(<a href="option.md#0x1_option_is_some">is_some</a>(t), <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>); let vec_ref = &mut t.vec; let old_value = <a href="vector.md#0x1_vector_pop_back">vector::pop_back</a>(vec_ref); <a href="vector.md#0x1_vector_push_back">vector::push_back</a>(vec_ref, e); old_value } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="option.md#0x1_option_AbortsIfNone">AbortsIfNone</a><Element>; ensures result == <a href="option.md#0x1_option_borrow">borrow</a>(old(t)); ensures <a href="option.md#0x1_option_is_some">is_some</a>(t); ensures <a href="option.md#0x1_option_borrow">borrow</a>(t) == e; </code></pre> </details>

Function `swap_or_fill`

Swap the old value inside <code>t</code> with <code>e</code> and return the old value; or if there is no old value, fill it with <code>e</code>. Different from swap(), swap_or_fill() allows for <code>t</code> not holding a value.

<pre><code>public fun <a href="option.md#0x1_option_swap_or_fill">swap_or_fill</a><Element>(t: &mut <a href="option.md#0x1_option_Option">option::Option</a><Element>, e: Element): <a href="option.md#0x1_option_Option">option::Option</a><Element> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_swap_or_fill">swap_or_fill</a><Element>(t: &mut <a href="option.md#0x1_option_Option">Option</a><Element>, e: Element): <a href="option.md#0x1_option_Option">Option</a><Element> { let vec_ref = &mut t.vec; let old_value = if (<a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(vec_ref)) <a href="option.md#0x1_option_none">none</a>() else <a href="option.md#0x1_option_some">some</a>(<a href="vector.md#0x1_vector_pop_back">vector::pop_back</a>(vec_ref)); <a href="vector.md#0x1_vector_push_back">vector::push_back</a>(vec_ref, e); old_value } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; ensures result == old(t); ensures <a href="option.md#0x1_option_borrow">borrow</a>(t) == e; </code></pre> </details>

Function `destroy_with_default`

Destroys <code>t.</code> If <code>t</code> holds a value, return it. Returns <code>default</code> otherwise

<pre><code>public fun <a href="option.md#0x1_option_destroy_with_default">destroy_with_default</a><Element: drop>(t: <a href="option.md#0x1_option_Option">option::Option</a><Element>, default: Element): Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_destroy_with_default">destroy_with_default</a><Element: drop>(t: <a href="option.md#0x1_option_Option">Option</a><Element>, default: Element): Element { let <a href="option.md#0x1_option_Option">Option</a> { vec } = t; if (<a href="vector.md#0x1_vector_is_empty">vector::is_empty</a>(&mut vec)) default else <a href="vector.md#0x1_vector_pop_back">vector::pop_back</a>(&mut vec) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == (if (<a href="option.md#0x1_option_is_some">is_some</a>(t)) <a href="option.md#0x1_option_borrow">borrow</a>(t) else default); </code></pre> </details>

Function `destroy_some`

Unpack <code>t</code> and return its contents Aborts if <code>t</code> does not hold a value

<pre><code>public fun <a href="option.md#0x1_option_destroy_some">destroy_some</a><Element>(t: <a href="option.md#0x1_option_Option">option::Option</a><Element>): Element </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_destroy_some">destroy_some</a><Element>(t: <a href="option.md#0x1_option_Option">Option</a><Element>): Element { assert!(<a href="option.md#0x1_option_is_some">is_some</a>(&t), <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>); let <a href="option.md#0x1_option_Option">Option</a> { vec } = t; let elem = <a href="vector.md#0x1_vector_pop_back">vector::pop_back</a>(&mut vec); <a href="vector.md#0x1_vector_destroy_empty">vector::destroy_empty</a>(vec); elem } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="option.md#0x1_option_AbortsIfNone">AbortsIfNone</a><Element>; ensures result == <a href="option.md#0x1_option_borrow">borrow</a>(t); </code></pre> </details>

Function `destroy_none`

Unpack <code>t</code> Aborts if <code>t</code> holds a value

<pre><code>public fun <a href="option.md#0x1_option_destroy_none">destroy_none</a><Element>(t: <a href="option.md#0x1_option_Option">option::Option</a><Element>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_destroy_none">destroy_none</a><Element>(t: <a href="option.md#0x1_option_Option">Option</a><Element>) { assert!(<a href="option.md#0x1_option_is_none">is_none</a>(&t), <a href="option.md#0x1_option_EOPTION_IS_SET">EOPTION_IS_SET</a>); let <a href="option.md#0x1_option_Option">Option</a> { vec } = t; <a href="vector.md#0x1_vector_destroy_empty">vector::destroy_empty</a>(vec) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if <a href="option.md#0x1_option_is_some">is_some</a>(t) with <a href="option.md#0x1_option_EOPTION_IS_SET">EOPTION_IS_SET</a>; </code></pre> </details>

Function `to_vec`

Convert <code>t</code> into a vector of length 1 if it is <code>Some</code>, and an empty vector otherwise

<pre><code>public fun <a href="option.md#0x1_option_to_vec">to_vec</a><Element>(t: <a href="option.md#0x1_option_Option">option::Option</a><Element>): <a href="vector.md#0x1_vector">vector</a><Element> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="option.md#0x1_option_to_vec">to_vec</a><Element>(t: <a href="option.md#0x1_option_Option">Option</a><Element>): <a href="vector.md#0x1_vector">vector</a><Element> { let <a href="option.md#0x1_option_Option">Option</a> { vec } = t; vec } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; aborts_if false; ensures result == t.vec; </code></pre> </details>

Function `for_each`

Apply the function to the optional element, consuming it.

<pre><code>public fun <a href="option.md#0x1_option_for_each">for_each</a><Element>(o: <a href="option.md#0x1_option_Option">option::Option</a><Element>, f: |Element|) </code></pre> <details> <summary>Implementation</summary> <pre><code>public inline fun <a href="option.md#0x1_option_for_each">for_each</a><Element>(o: <a href="option.md#0x1_option_Option">Option</a><Element>, f: |Element|) { if (<a href="option.md#0x1_option_is_some">is_some</a>(&o)) { f(<a href="option.md#0x1_option_destroy_some">destroy_some</a>(o)) } else { <a href="option.md#0x1_option_destroy_none">destroy_none</a>(o) } } </code></pre> </details>

Function `for_each_ref`

Apply the function to the optional element reference.

<pre><code>public fun <a href="option.md#0x1_option_for_each_ref">for_each_ref</a><Element>(o: &<a href="option.md#0x1_option_Option">option::Option</a><Element>, f: |&Element|) </code></pre> <details> <summary>Implementation</summary> <pre><code>public inline fun <a href="option.md#0x1_option_for_each_ref">for_each_ref</a><Element>(o: &<a href="option.md#0x1_option_Option">Option</a><Element>, f: |&Element|) { if (<a href="option.md#0x1_option_is_some">is_some</a>(o)) { f(<a href="option.md#0x1_option_borrow">borrow</a>(o)) } } </code></pre> </details>

Function `for_each_mut`

Apply the function to the optional element reference.

<pre><code>public fun <a href="option.md#0x1_option_for_each_mut">for_each_mut</a><Element>(o: &mut <a href="option.md#0x1_option_Option">option::Option</a><Element>, f: |&mut Element|) </code></pre> <details> <summary>Implementation</summary> <pre><code>public inline fun <a href="option.md#0x1_option_for_each_mut">for_each_mut</a><Element>(o: &mut <a href="option.md#0x1_option_Option">Option</a><Element>, f: |&mut Element|) { if (<a href="option.md#0x1_option_is_some">is_some</a>(o)) { f(<a href="option.md#0x1_option_borrow_mut">borrow_mut</a>(o)) } } </code></pre> </details>

Function `fold`

Folds the function over the optional element.

<pre><code>public fun <a href="option.md#0x1_option_fold">fold</a><Accumulator, Element>(o: <a href="option.md#0x1_option_Option">option::Option</a><Element>, init: Accumulator, f: |Accumulator, Element|Accumulator): Accumulator </code></pre> <details> <summary>Implementation</summary> <pre><code>public inline fun <a href="option.md#0x1_option_fold">fold</a><Accumulator, Element>( o: <a href="option.md#0x1_option_Option">Option</a><Element>, init: Accumulator, f: |Accumulator,Element|Accumulator ): Accumulator { if (<a href="option.md#0x1_option_is_some">is_some</a>(&o)) { f(init, <a href="option.md#0x1_option_destroy_some">destroy_some</a>(o)) } else { <a href="option.md#0x1_option_destroy_none">destroy_none</a>(o); init } } </code></pre> </details>

Function `map`

Maps the content of an option

<pre><code>public fun <a href="option.md#0x1_option_map">map</a><Element, OtherElement>(o: <a href="option.md#0x1_option_Option">option::Option</a><Element>, f: |Element|OtherElement): <a href="option.md#0x1_option_Option">option::Option</a><OtherElement> </code></pre> <details> <summary>Implementation</summary> <pre><code>public inline fun <a href="option.md#0x1_option_map">map</a><Element, OtherElement>(o: <a href="option.md#0x1_option_Option">Option</a><Element>, f: |Element|OtherElement): <a href="option.md#0x1_option_Option">Option</a><OtherElement> { if (<a href="option.md#0x1_option_is_some">is_some</a>(&o)) { <a href="option.md#0x1_option_some">some</a>(f(<a href="option.md#0x1_option_destroy_some">destroy_some</a>(o))) } else { <a href="option.md#0x1_option_destroy_none">destroy_none</a>(o); <a href="option.md#0x1_option_none">none</a>() } } </code></pre> </details>

Function `filter`

Filters the content of an option

<pre><code>public fun <a href="option.md#0x1_option_filter">filter</a><Element: drop>(o: <a href="option.md#0x1_option_Option">option::Option</a><Element>, f: |&Element|bool): <a href="option.md#0x1_option_Option">option::Option</a><Element> </code></pre> <details> <summary>Implementation</summary> <pre><code>public inline fun <a href="option.md#0x1_option_filter">filter</a><Element:drop>(o: <a href="option.md#0x1_option_Option">Option</a><Element>, f: |&Element|bool): <a href="option.md#0x1_option_Option">Option</a><Element> { if (<a href="option.md#0x1_option_is_some">is_some</a>(&o) && f(<a href="option.md#0x1_option_borrow">borrow</a>(&o))) { o } else { <a href="option.md#0x1_option_none">none</a>() } } </code></pre> </details>

Module Specification

<pre><code>pragma aborts_if_is_strict; </code></pre>

Helper Schema

<pre><code>schema <a href="option.md#0x1_option_AbortsIfNone">AbortsIfNone</a><Element> { t: <a href="option.md#0x1_option_Option">Option</a><Element>; aborts_if <a href="option.md#0x1_option_is_none">is_none</a>(t) with <a href="option.md#0x1_option_EOPTION_NOT_SET">EOPTION_NOT_SET</a>; } </code></pre>

Module `0x1::option`

Module 0x1::option

Struct Option

Constants

Function none

Function some

Function is_none

Function is_some

Function contains

Function borrow

Function borrow_with_default

Function get_with_default

Function fill

Function extract

Function borrow_mut

Function swap

Function swap_or_fill

Function destroy_with_default

Function destroy_some

Function destroy_none

Function to_vec

Function for_each

Function for_each_ref

Function for_each_mut

Function fold

Function map

Function filter

Module Specification

Helper Schema

Module `0x1::option`

Struct `Option`

Function `none`

Function `some`

Function `is_none`

Function `is_some`

Function `contains`

Function `borrow`

Function `borrow_with_default`

Function `get_with_default`

Function `fill`

Function `extract`

Function `borrow_mut`

Function `swap`

Function `swap_or_fill`

Function `destroy_with_default`

Function `destroy_some`

Function `destroy_none`

Function `to_vec`

Function `for_each`

Function `for_each_ref`

Function `for_each_mut`

Function `fold`

Function `map`

Function `filter`