ConversionOptions

Struct ConversionOptions 

Source
pub struct ConversionOptions {
    pub package_name: PackageName,
    pub interface_name: String,
    pub singleton_interface: Option<String>,
    pub unsupported_features: HandleUnsupported,
    pub global_singletons: HashSet<String>,
    pub phantom_interface: Vec<String>,
    pub phantom_dictionaries: Vec<String>,
    pub resource_inheritance: ResourceInheritance,
}
Expand description

conversion options.

Fields§

§package_name: PackageName

Name of package for generated wit.

When using the outputted wit in a JS environment, it is recommended to use the “webidl:” namespace.

This lets tools like Jco know that this wit represents bindings to built in functions.

Example

PackageName::new("webidl", "my-package", None);
§interface_name: String

Interface to hold the generated types and functions.

§singleton_interface: Option<String>

When set, treats the given interface name as a singleton, flattening its functions as top-level interface functions of an interface of the given name.

When using the outputted wit in a JS environment, it is recommended to make this name match the global name of the interface, with a global- prefix, for transparent runtime support in Jco.

For example in Jco, globalThis.console or globalThis.navigator.gpu can be reflected as global-console or global-navigator-gpu respectively to automatically bind these globals.

§unsupported_features: HandleUnsupported

Skip unsupported features.

§global_singletons: HashSet<String>

Items - usually global singletons - that if encountered should get a get-[self] func, and get a dedicated world.

§phantom_interface: Vec<String>

Add empty interfaces with these names. Useful if the WebIDL references interfaces not defined in the input.

§phantom_dictionaries: Vec<String>

Add empty dictionary with these names. Useful if the WebIDL references dictionaries not defined in the input.

§resource_inheritance: ResourceInheritance

How to handle resource inheritance.

Trait Implementations§

Source§

impl Clone for ConversionOptions

Source§

fn clone(&self) -> ConversionOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConversionOptions

Source§

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

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

impl Default for ConversionOptions

Source§

fn default() -> Self

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

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> 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 = Infallible

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.