Skip to main content

HostDefined

boa_engine

Struct HostDefined 

Source 
pub struct HostDefined<T: ?Sized = dyn NativeObject> { /* private fields */ }
Expand description

This represents a ECMAScript specification [HostDefined] field.

This allows storing types which are mapped by their TypeId.

Implementations§

Source§

impl HostDefined<dyn Any>

Source

pub fn insert_default<T: Any + Default>(&mut self) -> Option<Box<T>>

Insert a type into the HostDefined.

Source

pub fn insert<T: Any>(&mut self, value: T) -> Option<Box<T>>

Insert a type into the HostDefined.

Source

pub fn remove<T: Any>(&mut self) -> Option<Box<T>>

Remove type T from HostDefined, if it exists.

Returns Some with the object if it exits, None otherwise.

Source

pub fn get<T: Any>(&self) -> Option<&T>

Get type T from HostDefined, if it exists.

Source

pub fn get_mut<T: Any>(&mut self) -> Option<&mut T>

Get type T from HostDefined, if it exists.

Source

pub fn get_many_mut<T, const SIZE: usize>(&mut self) -> T::NativeTupleMutRef<'_>
where T: NativeTuple<SIZE>,

Get a tuple of types from HostDefined, returning None for the types that are not on the map.

Source§

impl HostDefined<dyn NativeObject>

Source

pub fn insert_default<T: NativeObject + Default>(&mut self) -> Option<Box<T>>

Insert a type into the HostDefined.

Source

pub fn insert<T: NativeObject>(&mut self, value: T) -> Option<Box<T>>

Insert a type into the HostDefined.

Source

pub fn remove<T: NativeObject>(&mut self) -> Option<Box<T>>

Remove type T from HostDefined, if it exists.

Returns Some with the object if it exits, None otherwise.

Source

pub fn get<T: NativeObject>(&self) -> Option<&T>

Get type T from HostDefined, if it exists.

Source

pub fn get_mut<T: NativeObject>(&mut self) -> Option<&mut T>

Get type T from HostDefined, if it exists.

Source

pub fn get_many_mut<T, const SIZE: usize>(&mut self) -> T::NativeTupleMutRef<'_>
where T: NativeTuple<SIZE>,

Get a tuple of types from HostDefined, returning None for the types that are not on the map.

Source§

impl<T: ?Sized> HostDefined<T>

Source

pub fn has<U: 'static>(&self) -> bool

Check if the HostDefined has type T.

Source

pub fn clear(&mut self)

Clears all the objects.

Trait Implementations§

Source§

impl<T: ?Sized> Default for HostDefined<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: ?Sized + Finalize> Finalize for HostDefined<T>

Source§

fn finalize(&self)

Cleanup logic for a type.
Source§

impl<T: ?Sized + Trace> Trace for HostDefined<T>

Source§

unsafe fn trace(&self, tracer: &mut Tracer)

Marks all contained Gcs. Read more
Source§

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root. Read more
Source§

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.

Auto Trait Implementations§

§

impl<T> Freeze for HostDefined<T>
where HashMap<TypeId, Box<T>>: Freeze, T: ?Sized,

§

impl<T> RefUnwindSafe for HostDefined<T>
where HashMap<TypeId, Box<T>>: RefUnwindSafe, T: ?Sized,

§

impl<T> Send for HostDefined<T>
where HashMap<TypeId, Box<T>>: Send, T: ?Sized,

§

impl<T> Sync for HostDefined<T>
where HashMap<TypeId, Box<T>>: Sync, T: ?Sized,

§

impl<T> Unpin for HostDefined<T>
where HashMap<TypeId, Box<T>>: Unpin, T: ?Sized,

§

impl<T> UnsafeUnpin for HostDefined<T>
where HashMap<TypeId, Box<T>>: UnsafeUnpin, T: ?Sized,

§

impl<T> UnwindSafe for HostDefined<T>
where HashMap<TypeId, Box<T>>: UnwindSafe, T: ?Sized,

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

Source§

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

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

impl<T> ErasedDestructor for T
where T: 'static,

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> 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, <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.