Struct Paper

Source

pub struct Paper { /* private fields */ }

Expand description

An instance of the paper application.

Once Paper has started running, it shall continue until it has been terminated. Termination occurs when the application is ordered to quit or an unrecoverable error is thrown.

When Paper is dropped, it shall kill all spawned processes and return the user interface to its previous state.

§Examples

use paper::{Arguments, Failure, Paper};

Paper::new(Arguments::default())?.run()?;

Implementations§

Source §

impl Paper

Source

pub fn new(arguments: Arguments) -> Result<Self, CreateError>

Creates a new instance of paper.

Source

pub fn run(&mut self) -> Result<(), RunError>

Runs the application.

This function shall run until paper has been terminated.

§Errors

If any unrecoverable error is thrown, a RunError shall be thrown.

Trait Implementations§

Source §

impl Debug for Paper

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for Paper

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<P, C> AssembleInto<C> for P
where C: AssembleFrom,

Source §

type Error = <C as AssembleFrom>::Error

Describes an error with the parts. Read more

Source §

fn assemble_into( parts: &mut Vec, ) -> Result<C, AssembleFailure<>::Error>>

Assembles parts into a C. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<P, C> DisassembleInto for C
where P: DisassembleFrom<C>,

Source §

type Error = >::Error

Describes an error that prevents disassembly.

Source §

fn disassemble_into(self) -> Result<Vec, <C as DisassembleInto>::Error>

Disassembles self into a sequence of parts. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §