Struct bellframe::method::Method

pub struct Method { /* fields omitted */ }

The definition of a ‘method’ within Change Ringing. This struct follows quite a loose definition, which allows the Method struct to represent things that may not count as methods (as determined by the Framework). Essentially, a Method consists of a Block which is intended to be rung as a repeating unit (usually a ‘lead’), along with names for specific locations within this Block. Calls can then be attached to these locations (by name), and thus the single lead can be modified to determine the effect of calls in a general way. This follows how complib.org’s composition input works.

Implementations

impl Method

pub fn new(name: String, first_lead: AnnotBlock<Option<String>>) -> Self

Creates a new Method given its name and a Block

pub fn from_place_not_string(
    name: String,
    stage: Stage,
    place_notation: &str
) -> Result<Self, PnBlockParseError>

Parses a place notation string and creates a Method with that place notation and no lead locations.

pub fn with_lead_end(name: String, block: &PnBlock) -> Self

Creates a new Method from some place notation, adding a lead end annotation.

pub fn lead(&self) -> &AnnotBlock<Option<String>>

Returns an AnnotBlock of the first lead of this Method

pub fn lead_head(&self) -> &Row

The overall transposing effect of one lead of this Method.

pub fn lead_len(&self) -> usize

How many Rows are in a single lead of this Method?

pub fn stage(&self) -> Stage

Gets the Stage of this Method

pub fn name(&self) -> &str

Gets the name of this Method

pub fn course_iter(&self, starting_row: Row) -> CourseIter<'_>

Generates a new CourseIter which generates an infinite course of this Method, starting at a given starting_row.

pub fn plain_course(&self) -> AnnotBlock<(usize, Option<&str>)>

Returns an AnnotBlock representing the plain course of this method

pub fn plain_course_iter(&self) -> CourseIter<'_>

Generates a new CourseIter which generates the plain course of this Method forever.

pub fn set_label(&mut self, index: usize, label: Option<String>)

Sets or clears the label at a given index, panicking if the index is out of range

pub fn get_label(&self, index: usize) -> Option<&str>

Returns the label at a given index, panicking if the index is out of range

Trait Implementations

impl Clone for Method

fn clone(&self) -> Method

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Method

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

Formats the value using the given formatter.