Documentation

BR Code

A crate to parse and emit PIX BR Code.

Usage

[dependencies]
brcode = "0.2.0"

Example

Parse String

use brcode::{from_str, Data};

fn main() {
    let code = "00020104141234567890123426580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-42665544000027300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5917NOME DO RECEBEDOR6008BRASILIA61087007490062190515RP12345678-201980390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304AD38";

    assert_eq!(from_str(code), expected());
}

fn expected() -> Vec<(usize, Data)> {
    vec![
        (0, Data::Single("01".to_string())), 
        (4, Data::Single("12345678901234".to_string())), 
        (26, Data::Vector(vec![
            (0, Data::Single("BR.GOV.BCB.PIX".to_string())), 
            (1, Data::Single("123e4567-e12b-12d1-a456-426655440000".to_string()))])), 
        (27, Data::Vector(vec![
            (0, Data::Single("BR.COM.OUTRO".to_string())), 
            (1, Data::Single("0123456789".to_string()))])), 
        (52, Data::Single("0000".to_string())), 
        (53, Data::Single("986".to_string())), 
        (54, Data::Single("123.45".to_string())), 
        (58, Data::Single("BR".to_string())), 
        (59, Data::Single("NOME DO RECEBEDOR".to_string())), 
        (60, Data::Single("BRASILIA".to_string())), 
        (61, Data::Single("70074900".to_string())), 
        (62, Data::Vector(vec![
            (5, Data::Single("RP12345678-2019".to_string()))])), 
        (80, Data::Vector(vec![(
            0, Data::Single("BR.COM.OUTRO".to_string())), 
            (1, Data::Single("0123.ABCD.3456.WXYZ".to_string()))])), 
        (63, Data::Single("AD38".to_string()))]
}

str_to_brcode

use brcode::{str_to_brcode, BrCode, Template, Info, MerchantInfo, Label};


fn main() {
    let code = "00020104141234567890123426580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-42665544000027300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5917NOME DO RECEBEDOR6008BRASILIA61087007490062190515RP12345678-201980390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304AD38";

    assert_eq!(from_str(code), expected());
}

fn expected() -> BrCode {
    BrCode {
        payload_version: 1,
        initiation_methos: None,
        merchant_category_code: 0000u32,
        merchant_name: "NOME DO RECEBEDOR".to_string(),
        merchant_city: "BRASILIA".to_string(),
        merchant_information: vec![
            MerchantInfo {
                id: 26,
                info: vec![
                    Info {
                        id: 0,
                        info: "BR.GOV.BCB.PIX".to_string(),
                    },
                    Info {
                        id: 1,
                        info: "123e4567-e12b-12d1-a456-426655440000".to_string(),
                    },
                ],
            },
            MerchantInfo {
                id: 27,
                info: vec![
                    Info {
                        id: 0,
                        info: "BR.COM.OUTRO".to_string(),
                    },
                    Info {
                        id: 1,
                        info: "0123456789".to_string(),
                    },
                ],
            },
        ],
        currency: "986".to_string(),
        postal_code: Some("70074900".to_string()),
        amount: Some(123.45),
        country_code: "BR".to_string(),
        field_template: vec![Label {
            reference_label: "RP12345678-2019".to_string(),
        }],
        crc1610: "AD38".to_string(),
        templates: Some(vec![Template {
            id: 80usize,
            info: vec![
                Info {
                    id: 0usize,
                    info: "BR.COM.OUTRO".to_string(),
                },
                Info {
                    id: 1usize,
                    info: "0123.ABCD.3456.WXYZ".to_string(),
                },
            ],
        }]),
    }
}

FFI

Clojure FFI

DOCS

BR Code as Edn call function edn_from_brcode or use clojar [clj-brcode "0.2.0-SNAPSHOT"]. Example:

(ns example.core
  (:require [clj-brcode.core :refer :all]))

(def code "00020104141234567890123426580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-42665544000027300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5917NOME DO RECEBEDOR6008BRASILIA61087007490062190515RP12345678-201980390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304AD38")

(brcode-from-str code)

; {:payload-version 1, :initiation-methos nil, :merchant-information [{:id 26, :info [{:id 0, :info "BR.GOV.BCB.PIX"}, {:id 1, :info "123e4567-e12b-12d1-a456-426655440000"}]}, {:id 27, :info [{:id 0, :info "BR.COM.OUTRO"}, {:id 1, :info "0123456789"}]}], :merchant-category-code 0, :merchant-name "NOME DO RECEBEDOR", :merchant-city "BRASILIA", :postal-code "70074900", :currency "986", :amount 123.45, :country-code "BR", :field-template [{:reference-label "RP12345678-2019"}], :crc1610 "AD38", :templates [{:id 80, :info [{:id 0, :info "BR.COM.OUTRO"}, {:id 1, :info "0123.ABCD.3456.WXYZ"}]}]}

Input:

"00020104141234567890123426580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-42665544000027300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5917NOME DO RECEBEDOR6008BRASILIA61087007490062190515RP12345678-201980390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304AD38"

Expected Edn:

{ :payload-version 1, 
  :initiation-methos nil, 
  :merchant-information 
    [{ :id 26, :info 
        [{ :id 0, :info "BR.GOV.BCB.PIX", }, 
         { :id 1, :info "123e4567-e12b-12d1-a456-426655440000", }
        ] },
     { :id 27, :info 
        [{ :id 0, :info "BR.COM.OUTRO", }, 
         { :id 1, :info "0123456789", }
        ]}
    ], 
  :merchant-category-code 0, 
  :merchant-name "NOME DO RECEBEDOR", 
  :merchant-city "BRASILIA", 
  :postal-code "70074900", 
  :currency "986", 
  :amount 123.45, 
  :country-code "BR", 
  :field-template [{ :reference-label "RP12345678-2019", }], 
  :crc1610 "AD38", 
  :templates 
    [{ :id 80, :info 
        [{ :id 0, :info "BR.COM.OUTRO", },
         { :id 1, :info "0123.ABCD.3456.WXYZ", }], }], }

Node FFI

DOCS

BR Code as Json call function parse. Example:

const brcode = require('./index');

const code = "00020104141234567890123426580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-42665544000027300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5917NOME DO RECEBEDOR6008BRASILIA61087007490062190515RP12345678-201980390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304AD38";

console.log(brcode.parse(code));
// {
//     "payload_version":1,
//     "initiation_methos":null,
//     "merchant_information":[
//         {"id":26,"info":[
//             {"id":0,"info":"BR.GOV.BCB.PIX"},
//             {"id":1,"info":"123e4567-e12b-12d1-a456-426655440000"}
//         ]},
//         {"id":27,"info":[
//             {"id":0,"info":"BR.COM.OUTRO"},
//             {"id":1,"info":"0123456789"}
//         ]}
//     ],
//     "merchant_category_code":0,
//     "merchant_name":"NOME DO RECEBEDOR",
//     "merchant_city":"BRASILIA",
//     "postal_code":"70074900",
//     "currency":"986",
//     "amount":123.45,
//     "country_code":"BR",
//     "field_template":[{"reference_label":"RP12345678-2019"}],
//     "crc1610":"AD38",
//     "templates":[
//         {"id":80,"info":[
//             {"id":0,"info":"BR.COM.OUTRO"},
//             {"id":1,"info":"0123.ABCD.3456.WXYZ"}
//         ]}
//     ]
// }

Input:

"00020104141234567890123426580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-42665544000027300012BR.COM.OUTRO011001234567895204000053039865406123.455802BR5917NOME DO RECEBEDOR6008BRASILIA61087007490062190515RP12345678-201980390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304AD38"

Expected Json:

{
    "payload_version":1,
    "initiation_methos":null,
    "merchant_information":[
        {"id":26,"info":[
            {"id":0,"info":"BR.GOV.BCB.PIX"},
            {"id":1,"info":"123e4567-e12b-12d1-a456-426655440000"}
        ]},
        {"id":27,"info":[
            {"id":0,"info":"BR.COM.OUTRO"},
            {"id":1,"info":"0123456789"}
        ]}
    ],
    "merchant_category_code":0,
    "merchant_name":"NOME DO RECEBEDOR",
    "merchant_city":"BRASILIA",
    "postal_code":"70074900",
    "currency":"986",
    "amount":123.45,
    "country_code":"BR",
    "field_template":[{"reference_label":"RP12345678-2019"}],
    "crc1610":"AD38",
    "templates":[
        {"id":80,"info":[
            {"id":0,"info":"BR.COM.OUTRO"},
            {"id":1,"info":"0123.ABCD.3456.WXYZ"}
        ]}
    ]
}

Benchmark

from_str in benches/parse.rs

time:   [16.200 us 16.251 us 16.319 us] 

str_to_brcode in benches/to_brcode

time:   [25.424 us 25.570 us 25.710 us]

edn_from_brcode in benches/to_brcode

time:   [55.027 us 55.202 us 55.382 us]

json_from_brcode in benches/to_brcode

time:   [30.717 us 30.981 us 31.303 us]

Goals

  • Parse BR Code String;
  • Parse BR Code to BrCode struct;
  • Emit BR Code from Vec<(usize, Data)>;
  • Emit BR Code from BrCode struct;
  • FFI for parse
    • JS/Node
    • Json
    • Edn
    • Clojure
  • FFI for emit
    • JS/Node
    • Json
    • Edn
    • Clojure