Struct sqa_jack::port::JackPort

pub struct JackPort { /* private fields */ }

An object used for moving data of any type in or out of the client.

Ports may be connected in various ways.

Each port has a short name. The port’s full name contains the name of the client concatenated with a colon (:) followed by its short name. The jack_port_name_size() is the maximum length of this full name. Exceeding that will cause port registration to fail and return ProgrammerError.

Implementations

impl JackPort

pub fn as_ptr(&self) -> JackPortPtr

pub unsafe fn from_ptr(ptr: JackPortPtr) -> Self

pub fn set_short_name(&mut self, name: &str) -> JackResult<()>

Modify a port’s short name. May be called at any time.

If the resulting full name (including the “client_name:” prefix) is longer than jack_port_name_size(), it will be truncated.

pub fn get_name(&self, short: bool) -> JackResult<Cow<'_, str>>

Get the name of a port (short or long, determined by the short argument).

pub fn get_type(&self) -> JackResult<Cow<'_, str>>

Get the type string of a port.

pub unsafe fn get_name_raw(&self, short: bool) -> JackResult<*const c_char>

Get the raw pointer to the name of a port.

Safety

This function is not intended for external consumption.

pub fn get_flags(&self) -> JackPortFlags

Get the JackPortFlags of the port.

Trait Implementations

impl Clone for JackPort

fn clone(&self) -> JackPort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JackPort

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

Formats the value using the given formatter.

impl Copy for JackPort

impl Send for JackPort