Struct Plaintext 

pub struct Plaintext(/* private fields */);

Plaintext.

Wraps plaintext bytes. This type is limited on purpose, to prevent accidentally leaking the plaintext. Security properties are enforced by secstr::SecVec.

Implementations

impl Plaintext

pub fn empty() -> Self

New empty plaintext.

pub fn unsecure_ref(&self) -> &[u8]

Get unsecure reference to inner data.

Warning

Unsecure because we cannot guarantee that the referenced data isn’t cloned. Use with care!

The reference itself is safe to use and share. Data may be cloned from this reference though, when that happens we lose track of it and are unable to securely handle it in memory. You should clone Plaintext instead.

pub fn unsecure_to_str(&self) -> Result<&str, Utf8Error>

Get the plaintext as UTF8 string.

Warning

Unsecure because we cannot guarantee that the referenced data isn’t cloned. Use with care!

The reference itself is safe to use and share. Data may be cloned from this reference though, when that happens we lose track of it and are unable to securely handle it in memory. You should clone Plaintext instead.

pub fn first_line(&self) -> Result<Plaintext>

Get the first line of this secret as plaintext.

Returns empty plaintext if there are no lines.

pub fn except_first_line(&self) -> Result<Plaintext>

Get all lines execpt the first one.

Returns empty plaintext if there are no lines.

pub fn property(&self, property: &str) -> Result<Plaintext>

Get line with the given property.

Returns line with the given property. The property prefix is removed, and only the trimmed value is returned. Returns an error if the property does not exist.

This will never return the first line being the password.

pub fn append(&mut self, other: Plaintext, newline: bool)

Append other plaintext.

Optionally adds platform newline.

pub fn is_empty(&self) -> bool

Check whether this plaintext is empty.

• Empty if 0 bytes
• Empty if bytes parsed as UTF-8 has trimmed length of 0 characters (ignored on encoding failure)

Trait Implementations

impl Clone for Plaintext

fn clone(&self) -> Plaintext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<&str> for Plaintext

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Plaintext

fn from(other: String) -> Plaintext

Converts to this type from the input type.

impl From<Vec<u8>> for Plaintext

fn from(other: Vec<u8>) -> Plaintext

Converts to this type from the input type.

impl PartialEq for Plaintext

fn eq(&self, other: &Plaintext) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Plaintext

impl StructuralPartialEq for Plaintext