Struct beep_evdev::Note

pub struct Note { /* private fields */ }

A note of a certain frequency and duration that may be repeated with a delay

Implementations

impl Note

pub const fn new( frequency: u16, length: Duration, repeats: u16, delay: Duration ) -> Self

Creates a new note

Attributes

• frequency - The frequency in Hertz
• length - The length in milliseconds
• repeats - The amount of repeats
• delay - The delay in seconds when repeating

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

Plays the note

Examples

use beep_evdev::Note;

Note::default().play().expect("could not play melody :-(");

Errors

Returns an std::io::Error on I/O errors

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Default for Note

fn default() -> Self

Returns the “default value” for a type.

impl From<(u16, Duration)> for Note

fn from((frequency, length): (u16, Duration)) -> Self

Creates a note from a (frequency, length) tuple with default repeats and delay

impl From<(u16, u64)> for Note

fn from((frequency, length): (u16, u64)) -> Self

Creates a note from a (frequency, length) tuple with default repeats and delay

impl PartialEq<Note> for Note

fn eq(&self, other: &Note) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Note

impl StructuralEq for Note

impl StructuralPartialEq for Note