Struct DeckList 

pub struct DeckList { /* private fields */ }

The game Marvel Snap allows sharing decks through the use of encoded strings. This simple crate supports both encoding and decoding of that data to support building other tools on top of the deck information.

It does not include actual card data to keep this library simple as cards are added to the pool frequently enough that this would get stale.

Example (To Share)

use marvelsnapdeck::DeckList;

let mut list = DeckList::new();
list.set_name("Thanos".to_string());
list.set_cards(&["AntMan", "Agent13", "Quinjet", "Angela",
"Okoye", "Armor", "Falcon", "Mystique", "Lockjaw",
"KaZar", "DevilDinosaur", "Thanos"]);
let code = list.into_code().unwrap();

Example (From Code)

use marvelsnapdeck::DeckList;

let clipboard = "...";
let mut list = DeckList::from_code(clipboard);

Implementations

impl DeckList

pub fn new() -> Self

Create an empty DeckList to prepare

pub fn set_name(&mut self, name: String)

Set the deck name visible to the player in game

Example

use marvelsnapdeck::DeckList;

let mut list = DeckList::new();
list.set_name("Thanos".into());

assert_eq!(list.name(), "Thanos");

pub fn name(&self) -> &str

Gets the deck name visible to the player in game

Example

use marvelsnapdeck::DeckList;

let mut list = DeckList::new();
list.set_name("Thanos".into());

assert_eq!(list.name(), "Thanos");

pub fn set_cards<T: AsRef<str> + Display>(&mut self, cards: &[T])

Set the list of cards.

Example

use marvelsnapdeck::DeckList;

let mut list = DeckList::new();
list.set_cards(&["AntMan"]);

let output = list.cards();

assert_eq!(output[0], "AntMan");

pub fn cards(&self) -> Vec<String>

Get list of cards as a vector of strings

Example

use marvelsnapdeck::DeckList;

let mut list = DeckList::new();
list.set_cards(&["AntMan"]);

let output = list.cards();

assert_eq!(output[0], "AntMan");

pub fn from_code<T: AsRef<[u8]>>(code: T) -> Result<Self, DeckListError>

Convert a string copied from Marvel Snap into a DeckList.

Panics

Panics if the code cannot be resolved into a valid DeckList struct.

pub fn into_code(&self) -> Result<String, DeckListError>

Converts DeckList into a string for pasting into Marvel Snap

For a complete deck, make sure to set both the deck name and include 12 valid cards. For simplicity, this library does not validate if the cards exist in the game.

Example

use marvelsnapdeck::DeckList;

let mut list = DeckList::new();
list.set_name("Thanos".to_string());
list.set_cards(&["AntMan", "Agent13", "Quinjet", "Angela",
"Okoye", "Armor", "Falcon", "Mystique", "Lockjaw",
"KaZar", "DevilDinosaur", "Thanos"]);
let code = list.into_code().unwrap();

Panics

Panics if the underlying card list fails to encode as a string

Trait Implementations

impl Clone for DeckList

fn clone(&self) -> DeckList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeckList

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

Formats the value using the given formatter.

impl Default for DeckList

fn default() -> DeckList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeckList

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeckList

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for DeckList

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeckList