Struct prs_lib::types::Plaintext[−][src]

pub struct Plaintext(_);

Expand description

Plaintext.

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

Implementations

[src]

impl Plaintext

[src]

pub fn empty() -> Self

New empty plaintext.

[src]

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.

[src]

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.

[src]

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

Get the first line of this secret as plaintext.

Returns empty plaintext if there are no lines.

[src]

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

Get all lines execpt the first one.

Returns empty plaintext if there are no lines.

[src]

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.

[src]

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

Append other plaintext.

Optionally adds platform newline.

[src]

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

[src]

impl Clone for Plaintext

[src]

fn clone(&self) -> Plaintext

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl From<&'_ str> for Plaintext

[src]

fn from(s: &str) -> Self

Performs the conversion.

[src]

impl From<String> for Plaintext

[src]

fn from(other: String) -> Plaintext

Performs the conversion.

[src]

impl From<Vec<u8, Global>> for Plaintext

[src]

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

Performs the conversion.

[src]

impl PartialEq<Plaintext> for Plaintext

[src]

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

This method tests for self and other values to be equal, and is used by ==. Read more

[src]

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

This method tests for !=.

[src]

impl Eq for Plaintext

[src]

impl StructuralEq for Plaintext

[src]

impl StructuralPartialEq for Plaintext

Auto Trait Implementations

impl RefUnwindSafe for Plaintext

impl Send for Plaintext

impl Sync for Plaintext

impl Unpin for Plaintext

impl UnwindSafe for Plaintext

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
    Scheme: ApproxScheme,

type Err = NoError

The error type produced by a failed conversion.

pub fn approx_from(
    src: Src
) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
    Dst: ApproxFrom<Src, Scheme>,
    Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

pub fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject with the default scheme.

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, Scheme>,
    Scheme: ApproxScheme,

Approximate the subject with a specific scheme.

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject to a given type with the default scheme.

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, Scheme>,
    Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.

fn into_as<Dst>(self) -> Dst where
    Self: Into<Dst>,

Convert the subject to a given type.

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
    Self: TryInto<Dst>,

Attempt to convert the subject to a given type.

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
    Self: ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<Src> TryFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

pub fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<Src, Dst> TryInto<Dst> for Src where
    Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

pub fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<Src> ValueFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

pub fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.

impl<Src, Dst> ValueInto<Dst> for Src where
    Dst: ValueFrom<Src>,

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.

pub fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.