Struct bishop::bishop_art::BishopArt

pub struct BishopArt { /* fields omitted */ }

Visualizer

Methods

impl BishopArt

pub fn with_size(w: usize, h: usize) -> Result<BishopArt>

Creates new BishopArt instance

Arguments

• w - width of the field
• h - height of the field

Field size must be within limits defined in GEOMETRY_LIMITS_MIN and GEOMETRY_LIMITS_MAX

Errors

Returns BishopError::Err on limits violation

Important traits for BishopArt

impl Write for BishopArt

pub fn new() -> BishopArt

Creates new BishopArt instance with default field size

pub fn input<T: AsRef<[u8]>>(&mut self, i: T)

Push bytes for visualising.

You can push any amount of data until result() is called

Note that pushed data is drawn on field as-is, without any additional hashing. Amount of data effective for visualizing on field with default size is somewhere around 64 bytes. Consider using hashing if your data is bigger than this

pub fn chain<T: AsRef<[u8]>>(self, i: T) -> Self

Same as input() but suitable for chaining

Example

let art = BishopArt::new()
    .chain(b"foo")
    .chain(b"bar")
    .draw();

pub fn result(self) -> BishopResult

Finalize the field and return BishopResult

Note that this method consumes BishopArt

pub fn draw_with_opts(self, o: &DrawingOptions) -> String

Draw resulting field to String using parameters from DrawingOptions

Note that this method calls result() internally and therefore consumes BishopArt. If you want to reuse generated field for drawing it multiple times - use result() manually.

pub fn draw(self) -> String

Draw resulting field to String using default parameters

Note that this method calls result() internally and therefore consumes BishopArt. If you want to reuse generated field for drawing it multiple times - use result() manually.

Trait Implementations

impl Debug for BishopArt

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

Formats the value using the given formatter.

impl Write for BishopArt

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.