Struct Generator 

pub struct Generator(/* private fields */);

Represents the generator “base class”. A From impl lets you get to this object from any kind of generator.

Implementations

impl Generator

pub fn handle(&self) -> &Handle

pub fn into_handle(self) -> Handle

pub fn get_type(&self) -> Result<ObjectType>

pub fn cast_to<T: CastTarget>(&self) -> Result<Option<T>>

Try to cast this object to another object type. Will return Ok(None) if this is because of a type mismatch, otherwise Err. Clones self on success in order to prevent throwing the object away on error.

pub fn get_userdata(&self) -> Result<Option<Arc<dyn Any + Send + Sync>>>

pub fn set_userdata( &self, userdata: Option<impl Any + Send + Sync>, ) -> Result<()>

pub fn config_delete_behavior( &self, config: &DeleteBehaviorConfig, ) -> Result<()>

pub fn current_time(&self) -> DoubleProperty<'_>

pub fn suggested_automation_time(&self) -> DoubleProperty<'_>

pub fn pause(&self) -> Result<()>

pub fn play(&self) -> Result<()>

pub fn pitch_bend(&self) -> DoubleProperty<'_>

pub fn gain(&self) -> DoubleProperty<'_>

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Generator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl From<&BufferGenerator> for Generator

fn from(other: &BufferGenerator) -> Generator

Converts to this type from the input type.

impl From<&FastSineBankGenerator> for Generator

fn from(other: &FastSineBankGenerator) -> Generator

Converts to this type from the input type.

impl From<&Generator> for Handle

fn from(other: &Generator) -> Handle

Converts to this type from the input type.

impl From<&NoiseGenerator> for Generator

fn from(other: &NoiseGenerator) -> Generator

Converts to this type from the input type.

impl From<&StreamingGenerator> for Generator

fn from(other: &StreamingGenerator) -> Generator

Converts to this type from the input type.

impl From<BufferGenerator> for Generator

fn from(input: BufferGenerator) -> Generator

Converts to this type from the input type.

impl From<FastSineBankGenerator> for Generator

fn from(input: FastSineBankGenerator) -> Generator

Converts to this type from the input type.

impl From<Generator> for Handle

fn from(input: Generator) -> Handle

Converts to this type from the input type.

impl From<NoiseGenerator> for Generator

fn from(input: NoiseGenerator) -> Generator

Converts to this type from the input type.

impl From<StreamingGenerator> for Generator

fn from(input: StreamingGenerator) -> Generator

Converts to this type from the input type.

impl Hash for Generator

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Generator

fn cmp(&self, other: &Generator) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Generator

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

fn partial_cmp(&self, other: &Generator) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&Generator> for BufferGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &Generator) -> Result<BufferGenerator>

Performs the conversion.

impl TryFrom<&Generator> for FastSineBankGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &Generator) -> Result<FastSineBankGenerator>

Performs the conversion.

impl TryFrom<&Generator> for NoiseGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &Generator) -> Result<NoiseGenerator>

Performs the conversion.

impl TryFrom<&Generator> for StreamingGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &Generator) -> Result<StreamingGenerator>

Performs the conversion.

impl TryFrom<&Handle> for Generator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &Handle) -> Result<Generator>

Performs the conversion.

impl TryFrom<Generator> for BufferGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Generator) -> Result<BufferGenerator>

Performs the conversion.

impl TryFrom<Generator> for FastSineBankGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Generator) -> Result<FastSineBankGenerator>

Performs the conversion.

impl TryFrom<Generator> for NoiseGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Generator) -> Result<NoiseGenerator>

Performs the conversion.

impl TryFrom<Generator> for StreamingGenerator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Generator) -> Result<StreamingGenerator>

Performs the conversion.

impl TryFrom<Handle> for Generator

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Handle) -> Result<Generator>

Performs the conversion.

impl Eq for Generator

impl StructuralPartialEq for Generator