Skip to main content

Action

Enum Action 

Source
#[non_exhaustive]
pub enum Action {
Show 14 variants GoTo(Destination), GoToR { filename: String, dest: Destination, new_window: Option<bool>, }, GoToE { target: String, dest: Destination, new_window: Option<bool>, }, Launch { filename: String, new_window: Option<bool>, }, Uri { uri: String, is_map: bool, }, Named(String), JavaScript(String), SubmitForm { url: String, fields: Vec<String>, flags: u32, }, ResetForm { fields: Vec<String>, flags: u32, }, Hide { targets: Vec<String>, hide: bool, }, Sound, Movie, Thread { target: Option<String>, }, Other { subtype: String, },
}
Expand description

PDF action — what to do when a link / outline / page event fires.

stet does not execute most of these (no JS engine, no network access for URIs); the action is exposed as data for consumers that want to render link panels, route handlers, or convert to other formats.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

GoTo(Destination)

/S /GoTo — jump to a destination in this document.

§

GoToR

/S /GoToR — jump to a destination in another PDF.

Fields

§filename: String
§new_window: Option<bool>
§

GoToE

/S /GoToE — jump into an embedded PDF file.

Fields

§target: String
§new_window: Option<bool>
§

Launch

/S /Launch — launch an application or open a file.

Fields

§filename: String
§new_window: Option<bool>
§

Uri

/S /URI — open a URI / hyperlink.

Fields

§is_map: bool
§

Named(String)

/S /Named — viewer-defined named action (/NextPage, /PrevPage, /FirstPage, /LastPage, /Print, …).

§

JavaScript(String)

/S /JavaScript — execute the given JS source. Exposed as raw source; stet does not evaluate.

§

SubmitForm

/S /SubmitForm — submit form data to a URL.

Fields

§fields: Vec<String>
§flags: u32
§

ResetForm

/S /ResetForm — reset form fields to their default values.

Fields

§fields: Vec<String>
§flags: u32
§

Hide

/S /Hide — hide / show form fields by name.

Fields

§targets: Vec<String>
§hide: bool
§

Sound

/S /Sound — deprecated. Marker only; we don’t expose audio data.

§

Movie

/S /Movie — deprecated. Marker only.

§

Thread

/S /Thread — article thread navigation.

Fields

§target: Option<String>
§

Other

Unknown /S value. The raw subtype name is preserved for callers that want to recognise their own extensions.

Fields

§subtype: String

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

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 Action

Source§

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

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

impl PartialEq for Action

Source§

fn eq(&self, other: &Action) -> 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 Action

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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, 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, <T as TryFrom<U>>::Error>

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.