Struct monument::builder::Call

pub struct Call { /* private fields */ }

Builder API for a call.

Implementations

impl Call

pub fn new(symbol: impl Into<String>, place_notation: PlaceNot) -> Self

Starts building a call which replaces the lead end with a given PlaceNotation and is displayed with the given symbol.

pub fn debug_symbol(self, symbol: impl Into<String>) -> Self

If set, this call will use a different symbol for debugging as displaying. This is currently only used for bobs (which display as ‘’ but debug as ‘-’).

If debug_symbol isn’t called, this will be the same as the ‘display’ symbol.

pub fn maybe_debug_symbol<T: Into<String>>(self, symbol: Option<T>) -> Self

If passed Some(_), the behaviour is the same as Call::debug_symbol; if None is passed, the behaviour is reverted to the default (using the same symbol for debug and display).

pub fn calling_positions(self, positions: Vec<String>) -> Self

Forces the use of a given set of calling positions. The supplied Vec contains one String for every place, in order, including leading. For example, default calling positions for near bobs in Major would be vec!["L", "I", "B", "F", "V", "M", "W", "H"].

pub fn maybe_calling_positions(self, positions: Option<Vec<String>>) -> Self

If Some(_) is passed, behaves the same as Call::calling_positions. If None is passed, the calling_positions are reverted to the default.

pub fn label(self, label: impl Into<String>) -> Self

Sets the label marking where this call can be placed. If unset, all calls are applied to the lead end.

pub fn label_from_to(self, from: impl Into<String>, to: impl Into<String>) -> Self

Makes this call go to a different label than it goes from.

pub fn weight(self, weight: f32) -> Self

Sets the weight which is added every time this call is used.