Struct ForeignContext 

pub struct ForeignContext<'a>(/* private fields */);

A handle to a context that may become invalid under specific conditions.

Assumes the context was NOT constructed by the current extension. Accessing its associated native data is therefore unsafe.

Invalidity only occurs after the associated ExtensionContext object has been disposed. Therefore, callers should be prepared for operations on the context to fail at appropriate points.

This crate leverages FREGetFREContextFromExtensionContext to enable more advanced use cases, but doing so also increases overall complexity.

Implementations

impl<'a> ForeignContext<'a>

pub fn from_object(context: NonNullObject<'a>) -> Result<Self, ContextError>

Returns the associated context from an AS3 ExtensionContext object.

Errors

• ContextError::FfiCallFailed If context is not an ExtensionContext object.
• ContextError::ContextConflict If it is associated with the current context.

pub fn get_native_data(self) -> Result<Option<NonNullFREData>, FfiError>

Returns a pointer to the native data. Callers must understand its memory layout and explicitly treat it as either a borrow or a move.

Only fails if the context is invalid.

pub unsafe fn set_native_data( self, data: Option<NonNullFREData>, ) -> Result<(), FfiError>

Sets the native data pointer for the context.

Only fails if the context is invalid.

Safety

Callers must ensure that no valid native data is currently set, or that any previously associated native data has become invalid and its memory has been properly released.

If data is a non-null pointer, it must have well-defined ownership: it must be treated explicitly as either a borrow or a move.

If treated as a move, callers must ensure that the memory is properly released before FREContextFinalizer completes.

pub fn get_actionscript_data(self) -> Result<Object<'a>, FfiError>

Returns the ActionScript-side Context Data associated with the context.

ExtensionContext.actionScriptData

Only fails if the context is invalid.

pub fn set_actionscript_data(self, object: Object<'_>) -> Result<(), FfiError>

Sets the ActionScript-side Context Data associated with the context.

ExtensionContext.actionScriptData

Only fails if the context is invalid.

Trait Implementations

impl<'a> Clone for ForeignContext<'a>

fn clone(&self) -> ForeignContext<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Context<'a> for ForeignContext<'a>

fn as_handle(&self) -> NonNull<c_void>

fn is_valid(&self) -> bool

Returns whether the context is valid.

fn as_ptr(&self) -> FREContext

fn trace<T: ToUcstrLossy + Sized>(&self, message: T)

Sends a message to the debugger output.

fn event_dispatcher(&self) -> EventDispatcher

Returns an EventDispatcher used to perform asynchronous callbacks via the AS3 event system.

fn get_render_mode(&self, stage: Option<Stage<'a>>) -> RenderMode

Returns the render mode of the stage.

fn set_render_source( &self, source: MediaBuffer<'a>, display_object: NonNullObject<'a>, ) -> Result<(), FfiError>

FRESetRenderSource

fn with_media_buffer<F, R>(&self, media_buffer: MediaBuffer<'a>, f: F) -> R

where F: FnOnce(MediaBufferDataAdapter<'_>) -> R,

FREMediaBufferLock FREMediaBufferUnlock

impl<'a> Debug for ForeignContext<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ForeignContext<'a>

fn eq(&self, other: &ForeignContext<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for ForeignContext<'a>

impl<'a> Eq for ForeignContext<'a>

impl<'a> StructuralPartialEq for ForeignContext<'a>