ig-client 0.12.1

This crate provides a client for the IG Markets API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

/// Character set used for generated deal references.
///
/// This is nanoid's URL-safe alphabet (`[A-Za-z0-9_-]`), which is within IG's
/// permitted deal-reference charset. Defining it here — and routing every
/// deal-reference builder through [`get_id`] — keeps the charset in a single
/// place.
const DEAL_REF_ALPHABET: [char; 64] = nanoid::alphabet::SAFE;

/// Length, in characters, of a generated deal reference.
///
/// IG limits deal references to 30 characters.
const DEAL_REF_LENGTH: usize = 30;

/// Generates a unique deal reference as a `String`.
///
/// This function creates a `DEAL_REF_LENGTH`-character unique identifier drawn
/// from `DEAL_REF_ALPHABET` (nanoid's URL-safe alphabet) using the `nanoid`
/// library. The generated identifier is securely random and designed to be
/// collision-resistant, and stays within IG's permitted deal-reference charset.
///
/// # Returns
/// A freshly generated deal reference.
///
/// # Examples
/// ```
/// use ig_client::utils::id::get_id;
///
/// let deal_reference = get_id();
/// assert_eq!(deal_reference.len(), 30);
/// ```
#[must_use]
pub fn get_id() -> String {
    nanoid::nanoid!(DEAL_REF_LENGTH, &DEAL_REF_ALPHABET)
}