bare vocabulary
Factor handbook » Vocabulary index

Documentation
Binary Application Record Encoding (BARE)

Metadata

Authors:

John Benediktsson

Words

Tuple classes

Class	Superclass	Slots
cannot-be-void	tuple	type
data	tuple	length
duplicate-keys	tuple	keys
duplicate-values	tuple	values
enum	tuple	values
invalid-enum	tuple	value
invalid-length	tuple	length
invalid-union	tuple	value
list	tuple	type length
map	tuple	from to
not-enough-entries	tuple
optional	tuple	type
schema	tuple	types
struct	tuple	fields
union	tuple	members
unknown-type	tuple	name

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

Metadata files

resource:extra/bare/authors.txt
resource:extra/bare/summary.txt

Children

Vocabulary	Summary
bare.private