[−][src]Struct purezen::pd::Message

pub struct Message<'pd, N: ArrayLength<Atom<'pd>>> { /* fields omitted */ }

Pure Data messages

https://puredata.info/dev/PdMessages

Methods

`impl<'pd, N> Message<'pd, N> where N: ArrayLength<Atom<'pd>>,` [src]

`pub fn from_timestamp(timestamp: Timestamp) -> Self`[src]

Initialize a message with the given timestamp.

This is the primary constructor for all message objects.

`pub fn from_string( timestamp: Timestamp, init_string: &'pd str ) -> Result<Self, Error>`[src]

Adds elements to the message by tokenizing the given string. If a token is numeric then it is automatically resolved to a float. Otherwise the string is interpreted as a symbol. Note that the init_string is tokenized and should be provided in a buffer which may be edited.

`pub fn resolve_string<ArgN, BufN>( init_string: &'pd str, arguments_opt: Option<&Message<'pd, ArgN>>, offset: usize, buffer: &mut String<BufN> ) -> Result<(), Error> where ArgN: ArrayLength<Atom<'pd>>, BufN: ArrayLength<u8>,` [src]

Resolve arguments in a string with a given argument list into the given buffer.

The offset parameter adjusts the resolution of the $ argument.

In the case of message boxes, $0 refers to the graph id, which is the first argument in a graph's list of arguments. For all other objects, $1 refers to the first (0th) element of the argument. The offset is used to distinguish between these cases, by offsetting the argument index resolution.

`pub fn resolve_symbols_to_type(&mut self)`[src]

Converts symbolic elements referring to message element types (e.g. float or f) to those types. For instance, if an element has a symbolic value of float, then that element is converted into one of type FLOAT.

`pub fn get_num_elements(&self) -> usize`[src]

Get the number of elements in this message

`pub fn get_element(&self, index: usize) -> Option<&Atom>`[src]

Get the element at the particular lindex

`pub fn atom_is_equal_to(&self, index: usize, other: &Atom) -> bool`[src]

Is the atom at the given index equal to the other atom?

`pub fn set_timestamp(&mut self, timestamp: Timestamp)`[src]

Set the global timestamp of this message (in milliseconds)

`pub fn get_timestamp(&self) -> Timestamp`[src]

Get the global timestamp of this message (in milliseconds)

`pub fn is_float(&self, index: usize) -> bool`[src]

Is the given message element a float?

`pub fn is_symbol(&self, index: usize) -> bool`[src]

Is the given message element a symbol?

`pub fn is_symbol_str(&self, index: usize, test: &str) -> bool`[src]

Is the given message element a symbol that matches the given test string?

`pub fn is_bang(&self, index: usize) -> bool`[src]

Is the given message element a bang?

`pub fn has_format(&self, format: &str) -> bool`[src]

Does this message match the given format string

`pub fn get_type(&self, index: usize) -> Type`[src]

Get the type for the given message

`pub fn get_float(&self, index: usize) -> Option<f32>`[src]

Convenience function to get the float value from a particular message element

`pub fn get_symbol(&self, index: usize) -> Option<&str>`[src]

Get the symbol value for the given element

`pub fn set_element( &mut self, index: usize, value: Atom<'pd> ) -> Result<(), Error>`[src]

Set an element to the given atom value

Panics if the index exceeds the capacity of the buffer