<a id="0x1_acl"></a>

Module 0x1::acl

Access control list (acl) module. An acl is a list of account addresses who have the access permission to a certain object. This module uses a <code><a href="vector.md#0x1_vector">vector</a></code> to represent the list, but can be refactored to use a "set" instead when it's available in the language in the future.

• Struct ACL
• Constants
• Function empty
• Function add
• Function remove
• Function contains
• Function assert_contains
• Specification
  • Struct ACL
  • Function add
  • Function remove
  • Function contains
  • Function assert_contains

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

<a id="0x1_acl_ACL"></a>

Struct ACL

<pre><code><b>struct</b> <a href="acl.md#0x1_acl_ACL">ACL</a> <b>has</b> <b>copy</b>, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>list: <a href="vector.md#0x1_vector">vector</a>&lt;<b>address</b>&gt;</code> </dt> <dd> </dd> </dl> </details>

<a id="@Constants_0"></a>

Constants

<a id="0x1_acl_ECONTAIN"></a>

The ACL already contains the address.

<pre><code><b>const</b> <a href="acl.md#0x1_acl_ECONTAIN">ECONTAIN</a>: u64 = 0; </code></pre>

<a id="0x1_acl_ENOT_CONTAIN"></a>

The ACL does not contain the address.

<pre><code><b>const</b> <a href="acl.md#0x1_acl_ENOT_CONTAIN">ENOT_CONTAIN</a>: u64 = 1; </code></pre>

<a id="0x1_acl_empty"></a>

Function empty

Return an empty ACL.

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_empty">empty</a>(): <a href="acl.md#0x1_acl_ACL">acl::ACL</a> </code></pre> <details> <summary>Implementation</summary> <pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_empty">empty</a>(): <a href="acl.md#0x1_acl_ACL">ACL</a> { <a href="acl.md#0x1_acl_ACL">ACL</a>{ list: <a href="vector.md#0x1_vector_empty">vector::empty</a>&lt;<b>address</b>&gt;() } } </code></pre> </details>

<a id="0x1_acl_add"></a>

Function add

Add the address to the ACL.

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_add">add</a>(self: &<b>mut</b> <a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>) </code></pre> <details> <summary>Implementation</summary> <pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_add">add</a>(self: &<b>mut</b> <a href="acl.md#0x1_acl_ACL">ACL</a>, addr: <b>address</b>) { <b>assert</b>!(!self.list.<a href="acl.md#0x1_acl_contains">contains</a>(&addr), <a href="error.md#0x1_error_invalid_argument">error::invalid_argument</a>(<a href="acl.md#0x1_acl_ECONTAIN">ECONTAIN</a>)); self.list.push_back(addr); } </code></pre> </details>

<a id="0x1_acl_remove"></a>

Function remove

Remove the address from the ACL.

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_remove">remove</a>(self: &<b>mut</b> <a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>) </code></pre> <details> <summary>Implementation</summary> <pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_remove">remove</a>(self: &<b>mut</b> <a href="acl.md#0x1_acl_ACL">ACL</a>, addr: <b>address</b>) { <b>let</b> (found, index) = self.list.index_of(&addr); <b>assert</b>!(found, <a href="error.md#0x1_error_invalid_argument">error::invalid_argument</a>(<a href="acl.md#0x1_acl_ENOT_CONTAIN">ENOT_CONTAIN</a>)); self.list.<a href="acl.md#0x1_acl_remove">remove</a>(index); } </code></pre> </details>

<a id="0x1_acl_contains"></a>

Function contains

Return true iff the ACL contains the address.

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_contains">contains</a>(self: &<a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_contains">contains</a>(self: &<a href="acl.md#0x1_acl_ACL">ACL</a>, addr: <b>address</b>): bool { self.list.<a href="acl.md#0x1_acl_contains">contains</a>(&addr) } </code></pre> </details>

<a id="0x1_acl_assert_contains"></a>

Function assert_contains

assert! that the ACL has the address.

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_assert_contains">assert_contains</a>(self: &<a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>) </code></pre> <details> <summary>Implementation</summary> <pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_assert_contains">assert_contains</a>(self: &<a href="acl.md#0x1_acl_ACL">ACL</a>, addr: <b>address</b>) { <b>assert</b>!(self.<a href="acl.md#0x1_acl_contains">contains</a>(addr), <a href="error.md#0x1_error_invalid_argument">error::invalid_argument</a>(<a href="acl.md#0x1_acl_ENOT_CONTAIN">ENOT_CONTAIN</a>)); } </code></pre> </details>

<a id="@Specification_1"></a>

Specification

<a id="@Specification_1_ACL"></a>

Struct ACL

<pre><code><b>struct</b> <a href="acl.md#0x1_acl_ACL">ACL</a> <b>has</b> <b>copy</b>, drop, store </code></pre> <dl> <dt> <code>list: <a href="vector.md#0x1_vector">vector</a>&lt;<b>address</b>&gt;</code> </dt> <dd> </dd> </dl> <pre><code><b>invariant</b> <b>forall</b> i in 0..len(list), j in 0..len(list): list[i] == list[j] ==&gt; i == j; </code></pre>

<a id="0x1_acl_spec_contains"></a>

<pre><code><b>fun</b> <a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self: <a href="acl.md#0x1_acl_ACL">ACL</a>, addr: <b>address</b>): bool { <b>exists</b> a in self.list: a == addr } </code></pre>

<a id="@Specification_1_add"></a>

Function add

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_add">add</a>(self: &<b>mut</b> <a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>) </code></pre> <pre><code><b>aborts_if</b> <a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self, addr) <b>with</b> <a href="error.md#0x1_error_INVALID_ARGUMENT">error::INVALID_ARGUMENT</a>; <b>ensures</b> <a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self, addr); </code></pre>

<a id="@Specification_1_remove"></a>

Function remove

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_remove">remove</a>(self: &<b>mut</b> <a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>) </code></pre> <pre><code><b>aborts_if</b> !<a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self, addr) <b>with</b> <a href="error.md#0x1_error_INVALID_ARGUMENT">error::INVALID_ARGUMENT</a>; <b>ensures</b> !<a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self, addr); </code></pre>

<a id="@Specification_1_contains"></a>

Function contains

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_contains">contains</a>(self: &<a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>): bool </code></pre> <pre><code><b>ensures</b> result == <a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self, addr); </code></pre>

<a id="@Specification_1_assert_contains"></a>

Function assert_contains

<pre><code><b>public</b> <b>fun</b> <a href="acl.md#0x1_acl_assert_contains">assert_contains</a>(self: &<a href="acl.md#0x1_acl_ACL">acl::ACL</a>, addr: <b>address</b>) </code></pre> <pre><code><b>aborts_if</b> !<a href="acl.md#0x1_acl_spec_contains">spec_contains</a>(self, addr) <b>with</b> <a href="error.md#0x1_error_INVALID_ARGUMENT">error::INVALID_ARGUMENT</a>; </code></pre>