Documentation
Binary Application Record Encoding (BARE)
Metadata
Words
Error classes
Tuple classes
Singleton classes
Parsing words
Generic words
Ordinary words
Class predicate words
Files
Metadata files
Binary Application Record Encoding (BARE)
Metadata
| Authors: | John Benediktsson |
Words
Error classes
| Class | Superclass | Slots |
 cannot-be-void |  tuple | type |
| duplicate-keys | tuple | keys |
| duplicate-values | tuple | values |
| invalid-enum | tuple | value |
| invalid-length | tuple | length |
| invalid-union | tuple | value |
| not-enough-entries | tuple | |
| unknown-type | tuple | name |
Tuple classes
| Class | Superclass | Slots |
| data | tuple | length |
| enum | tuple | values |
| list | tuple | type length |
| map | tuple | from to |
| optional | tuple | type |
| schema | tuple | types |
| struct | tuple | fields |
| union | tuple | members |
Singleton classes
 bool |
| f32 |
| f64 |
| i16 |
| i32 |
| i64 |
| i8 |
| int |
| str |
| u16 |
| u32 |
| u64 |
| u8 |
| uint |
| void |
Parsing words
| Word | Syntax |
 SCHEMA: |
Generic words
| Word | Stack effect |
 read-bare | ( schema -- obj ) |
| write-bare | ( obj schema -- ) |
Ordinary words
| Word | Stack effect |
| <data> | ( length -- data ) |
| <enum> | ( values -- enum ) |
| <list> | ( type length -- list ) |
| <map> | ( from to -- map ) |
| <optional> | ( type -- optional ) |
| <schema> | ( types -- schema ) |
| <struct> | ( fields -- struct ) |
| <union> | ( members -- union ) |
| >bare | ( obj schema -- encoded ) |
| bare> | ( encoded schema -- obj ) |
| cannot-be-void | ( type -- * ) |
| define-schema | ( schema -- ) |
| duplicate-keys | ( keys -- * ) |
| duplicate-values | ( values -- * ) |
| invalid-enum | ( value -- * ) |
| invalid-length | ( length -- * ) |
| invalid-union | ( value -- * ) |
| load-schema | ( path -- schema ) |
| not-enough-entries | ( -- * ) |
| parse-schema | ( string -- schema ) |
| unknown-type | ( name -- * ) |
Class predicate words
| Word | Stack effect |
| bool? | ( object -- ? ) |
| cannot-be-void? | ( object -- ? ) |
| data? | ( object -- ? ) |
| duplicate-keys? | ( object -- ? ) |
| duplicate-values? | ( object -- ? ) |
| enum? | ( object -- ? ) |
| f32? | ( object -- ? ) |
| f64? | ( object -- ? ) |
| i16? | ( object -- ? ) |
| i32? | ( object -- ? ) |
| i64? | ( object -- ? ) |
| i8? | ( object -- ? ) |
| int? | ( object -- ? ) |
| invalid-enum? | ( object -- ? ) |
| invalid-length? | ( object -- ? ) |
| invalid-union? | ( object -- ? ) |
| list? | ( object -- ? ) |
| map? | ( object -- ? ) |
| not-enough-entries? | ( object -- ? ) |
| optional? | ( object -- ? ) |
| schema? | ( object -- ? ) |
| str? | ( object -- ? ) |
| struct? | ( object -- ? ) |
| u16? | ( object -- ? ) |
| u32? | ( object -- ? ) |
| u64? | ( object -- ? ) |
| u8? | ( object -- ? ) |
| uint? | ( object -- ? ) |
| union? | ( object -- ? ) |
| unknown-type? | ( object -- ? ) |
| void? | ( object -- ? ) |
Files
resource:extra/bare/bare.factor
resource:extra/bare/bare-docs.factor
resource:extra/bare/bare-tests.factor
resource:extra/bare/bare-docs.factor
resource:extra/bare/bare-tests.factor
Metadata files