Module sodoken::buffer

Additional types related to working with buffers.

The main sodoken buffer documentation is at the crate-level. You probably don’t need to reference the types here unless you are implementing a custom sodoken buffer type.

Structs

• BufReadMemLocked
  This read-only buffer type is mem_locked. Use this for passwords / private keys, etc, but NOT everything, locked memory is a finite resource.
• BufReadMemLockedSized
  This sized read-only buffer type is mem_locked. Use this for passwords / private keys, etc, but NOT everything, locked memory is a finite resource.
• BufWriteMemLocked
  This writable buffer type is mem_locked. Use this for passwords / private keys, etc, but NOT everything, locked memory is a finite resource.
• BufWriteMemLockedSized
  This writable buffer type is mem_locked. Use this for passwords / private keys, etc, but NOT everything, locked memory is a finite resource.
• ExtendGuard
  An extend guard, indicating we have gained access to extend the buffer.
• ReadGuard
  A read guard, indicating we have gained access to read buffer memory.
• ReadGuardSized
  A read guard, indicating we have gained access to read sized buffer memory.
• WriteGuard
  A write guard, indicating we have gained access to write buffer memory.
• WriteGuardSized
  A write guard, indicating we have gained access to write sized buffer memory.

Traits

• AsBufExtend
  A buffer that may be appended to and may or may not be mem_locked.
• AsBufRead
  A readable buffer that may or may not be mem_locked.
• AsBufReadSized
  A sized readable buffer that may or may not be mem_locked.
• AsBufWrite
  A writable buffer that may or may not be mem_locked.
• AsBufWriteSized
  A writable buffer that may or may not be mem_locked.
• AsExtendMut
  Indicates we can append bytes without pre-initializing them.
• AsRead
  Indicates we can dereference an item as a readable byte array.
• AsReadSized
  Indicates we can dereference a sized item as a readable byte array.
• AsWrite
  Indicates we can dereference an item as a mutable byte array.
• AsWriteSized
  Indicates we can dereference a sized item as a mutable byte array.