Enum pdfium_render::action::PdfAction

pub enum PdfAction<'a> {
    LocalDestination(PdfActionLocalDestination<'a>),
    RemoteDestination(PdfActionRemoteDestination<'a>),
    EmbeddedDestination(PdfActionEmbeddedDestination<'a>),
    Launch(PdfActionLaunch<'a>),
    Uri(PdfActionUri<'a>),
    Unsupported(PdfActionUnsupported<'a>),
}

The action associated with a clickable link or document bookmark.

Variants

LocalDestination(PdfActionLocalDestination<'a>)

RemoteDestination(PdfActionRemoteDestination<'a>)

EmbeddedDestination(PdfActionEmbeddedDestination<'a>)

Launch(PdfActionLaunch<'a>)

Uri(PdfActionUri<'a>)

Unsupported(PdfActionUnsupported<'a>)

Implementations

impl<'a> PdfAction<'a>

pub fn action_type(&self) -> PdfActionType

Returns the PdfActionType for this PdfAction.

Note that Pdfium does not support or recognize all PDF action types. For instance, Pdfium does not currently support or recognize the interactive Javascript action type supported by Adobe Acrobat or Foxit’s commercial PDF SDK. In these cases, Pdfium will return PdfActionType::Unsupported.

pub fn is_supported(&self) -> bool

Returns true if this PdfAction has an action type other than PdfActionType::Unsupported.

The PdfAction::as_local_destination_action(), PdfAction::as_remote_destination_action(), PdfAction::as_embedded_destination_action(), PdfAction::as_launch_action(), and PdfAction::as_uri_action() functions can be used to access properties and functions pertaining to a specific action type.

pub fn is_unsupported(&self) -> bool

Returns true if this PdfAction has an action type of PdfActionType::Unsupported.

Common properties shared by all PdfAction types can still be accessed for actions not recognized by Pdfium, but action-specific functionality will be unavailable.

pub fn as_local_destination_action( &self ) -> Option<&PdfActionLocalDestination<'_>>

Returns an immutable reference to the underlying PdfActionLocalDestination for this PdfAction, if this action has an action type of PdfActionType::GoToDestinationInSameDocument.

pub fn as_local_destination_action_mut( &mut self ) -> Option<&mut PdfActionLocalDestination<'a>>

Returns a mutable reference to the underlying PdfActionLocalDestination for this PdfAction, if this action has an action type of PdfActionType::GoToDestinationInSameDocument.

pub fn as_remote_destination_action( &self ) -> Option<&PdfActionRemoteDestination<'_>>

Returns an immutable reference to the underlying PdfActionRemoteDestination for this PdfAction, if this action has an action type of PdfActionType::GoToDestinationInRemoteDocument.

pub fn as_remote_destination_action_mut( &mut self ) -> Option<&mut PdfActionRemoteDestination<'a>>

Returns a mutable reference to the underlying PdfActionRemoteDestination for this PdfAction, if this action has an action type of PdfActionType::GoToDestinationInRemoteDocument.

pub fn as_embedded_destination_action( &self ) -> Option<&PdfActionEmbeddedDestination<'_>>

Returns an immutable reference to the underlying PdfActionEmbeddedDestination for this PdfAction, if this action has an action type of PdfActionType::GoToDestinationInEmbeddedDocument.

pub fn as_embedded_destination_action_mut( &mut self ) -> Option<&mut PdfActionEmbeddedDestination<'a>>

Returns a mutable reference to the underlying PdfActionEmbeddedDestination for this PdfAction, if this action has an action type of PdfActionType::GoToDestinationInEmbeddedDocument.

pub fn as_launch_action(&self) -> Option<&PdfActionLaunch<'_>>

Returns an immutable reference to the underlying PdfActionLaunch for this PdfAction, if this action has an action type of PdfActionType::Launch.

pub fn as_launch_action_mut(&mut self) -> Option<&mut PdfActionLaunch<'a>>

Returns a mutable reference to the underlying PdfActionLaunch for this PdfAction, if this action has an action type of PdfActionType::Launch.

pub fn as_uri_action(&self) -> Option<&PdfActionUri<'_>>

Returns an immutable reference to the underlying PdfActionUri for this PdfAction, if this action has an action type of PdfActionType::Uri.

pub fn as_uri_action_mut(&mut self) -> Option<&mut PdfActionUri<'a>>

Returns a mutable reference to the underlying PdfActionUri for this PdfAction, if this action has an action type of PdfActionType::Uri.

Trait Implementations

impl<'a> From<PdfActionEmbeddedDestination<'a>> for PdfAction<'a>

fn from(action: PdfActionEmbeddedDestination<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfActionLaunch<'a>> for PdfAction<'a>

fn from(action: PdfActionLaunch<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfActionLocalDestination<'a>> for PdfAction<'a>

fn from(action: PdfActionLocalDestination<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfActionRemoteDestination<'a>> for PdfAction<'a>

fn from(action: PdfActionRemoteDestination<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfActionUnsupported<'a>> for PdfAction<'a>

fn from(action: PdfActionUnsupported<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfActionUri<'a>> for PdfAction<'a>

fn from(action: PdfActionUri<'a>) -> Self

Converts to this type from the input type.