v0.4.0 #13
Merged
v0.4.0 #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`@ValueSet` decorator set the value of the decorated property based on
a function passed as a parameter.
This decorator don't read anything from the binary file and is just used
to add more context to a class during the reading.
In the following example `@ValueSet` is used to fetch the protocol type name
based on an id read in by the binary definition.
The `protocol_name` will just appear when the object is serialized and will
gave the object more context.
```typescript
const ID_TO_NAME = {
1: "Record",
...
}
class Protocol {
@relation(PrimitiveSymbol.u8)
protocol_id: number
@ValueSet(_ => ID_TO_NAME[_.protocol_id] || 'UNKNOWN')
protocol_name: string
}
```
`Ctx` decorators are a way to share informations across
objects during the reading of the binary file definition.
In the following example, a streaming protocol that receives records
of arbitrary length is defined.
Records have two different type a 'definition' or a 'data' both use an
'id' to identify themself. The definition defines the size of the data
message they define by using `CtxSet` to store that size into the
context. The data message uses `CtxGet` to fetch its size defined
previously by the definition.
```typescript
class RecordDefinition {
@relation(PrimitiveSymbol.u8)
id: number
@CtxSet(_ => `Definition.${_.id}`)
@relation(PrimitiveSymbol.u8)
size: number
}
class RecordMessage {
@relation(PrimitiveSymbol.u8)
id: number
@CtxGet(_ => `Definition.${_.id}`)
_size: number
@count('_size')
@relation(PrimitiveSymbol.u8)
data
}
class Record {
@relation(PrimitiveSymbol.u8)
type: number
@choice('type', {
0x00: RecordDefinition,
0x01: RecordMessage,
})
message: RecordDefinition | RecordMessage
}
class Protocol {
@until(EOF)
records: Record[]
}
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.