Skip to main content

TranscriptLine

Enum TranscriptLine 

Source
pub enum TranscriptLine {
    Alert {
        title: String,
        message: String,
        icon: i32,
        button: i32,
    },
    Beep(i32),
    Response {
        question: String,
        title: String,
        default_value: String,
        label: String,
        password: bool,
    },
    MailMsg {
        ui: bool,
        to: String,
        cc: String,
        bcc: String,
        subject: String,
        body: String,
    },
    Print {
        ui: bool,
        start: i32,
        end: i32,
        silent: bool,
        shrink_to_fit: bool,
        print_as_image: bool,
        reverse: bool,
        annotations: bool,
    },
    SubmitForm {
        url: String,
        data: Vec<u8>,
    },
    GotoPage(i32),
    NamedAction(String),
    ConsolePrintln(String),
    FunctionAlert {
        caller: String,
        message: String,
    },
}
Available on crate feature javascript only.
Expand description

One thing a script asked the host to do.

Ten shapes, because the goldens carry ten. Each variant’s render output is quoted from the callback that produces it.

Variants§

§

Alert

app.alert — 1933 of the 2004 golden lines.

The message is printed with a conditional decoration: see TranscriptLine::render.

Fields

§title: String

cTitle, defaulting to the literal "Alert".

§message: String

cMsg. An array argument is joined first — see app.alert.

§icon: i32

nIcon, defaulting to 0.

§button: i32

nType, defaulting to 0.

§

Beep(i32)

app.beep(n) — ExampleAppBeep.

§

Response

app.response(...) — ExampleAppResponse. The host answers with the empty string; nothing is prompted.

Fields

§question: String

cQuestion.

§title: String

cTitle.

§default_value: String

cDefault.

§label: String

cLabel.

§password: bool

bPassword.

§

MailMsg

app.mailMsg / Doc.mailDoc / Doc.mailForm — ExampleDocMail. Nothing is sent: no network, no MAPI, no process spawn.

Fields

§ui: bool

bUI.

§to: String

To.

§cc: String

cc.

§bcc: String

bcc.

§subject: String

cSubject.

§body: String

cMsg.

§

Print

Doc.print — ExampleDocPrint. Nothing is printed.

Fields

§ui: bool

bUI.

§start: i32

nStart.

§end: i32

nEnd.

§silent: bool

bSilent.

§shrink_to_fit: bool

bShrinkToFit.

§print_as_image: bool

bPrintAsImage.

§reverse: bool

bReverse.

§annotations: bool

bAnnotations.

§

SubmitForm

Doc.submitForm — ExampleDocSubmitForm.

The most dangerous entry point in the object model, and the one where “hand back the data, do not act on it” matters most. No request is made; the URL and the bytes come back here for a host to decide about.

Fields

§url: String

Where the script wanted to post.

§data: Vec<u8>

What it wanted to post.

§

GotoPage(i32)

Doc.gotoNamedDest and page navigation — ExampleDocGotoPage.

§

NamedAction(String)

A named action fired from a non-JavaScript callback — ExampleNamedAction. named_action.in is its one fixture.

§

ConsolePrintln(String)

console.println. The oracle discards it, so this variant renders to nothing and is carried only so a host can see what a script logged.

§

FunctionAlert

An AF* function’s own alert, which is not routed through app.alert.

The function’s own name is the title, always with icon = 3 and button = 0 — so these render in the decorated form and appear unprefixed by Alert:, interleaved with the plain lines. Getting that interleaving right is a scoring requirement.

Fields

§caller: String

The function’s own name, e.g. AFNumber_Keystroke.

§message: String

The message.

Implementations§

Source§

impl TranscriptLine

Source

pub fn render(&self) -> Option<String>

The line the oracle would print, without its newline.

None for a shape that prints nothing — TranscriptLine::ConsolePrintln alone, because the oracle’s console methods are empty.

§The alert decoration is conditional, and it is exact

Three forms, chosen by what differs from the default:

conditionline
default title, icon and typeAlert: <msg>
non-default title only<title>: <msg>
non-default icon or type<title>[icon=N,type=N]: <msg>

An AF* alert always takes the third form with icon=3,type=0, so it reads AFNumber_Keystroke[icon=3,type=0]: The input value is invalid. with no Alert: prefix.

Source

pub fn alert(message: impl Into<String>) -> TranscriptLine

A default-decoration alert: the shape 1922 of the 2004 golden lines take.

Trait Implementations§

Source§

impl Clone for TranscriptLine

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TranscriptLine

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TranscriptLine

Source§

impl PartialEq for TranscriptLine

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TranscriptLine

Auto Trait Implementations§

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<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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.