Skip to main content

Crate fomoxa_attributes

Crate fomoxa_attributes 

Source
Expand description

The official Fomoxa attributes.

fomoxa-attributes  →  your source  →  fomoxac  →  generated code

This crate defines network and codec, and does nothing with them. It is the syntax half of Fomoxa: the part that makes annotated Rust compile, so that fomoxac has something to read.

use fomoxa_attributes::*;

#[network]
#[codec]
struct DeviceState {
    #[network(u32)]
    #[codec(edge, unity)]
    id: u32,

    #[network(f32)]
    #[codec(edge)]
    temperature: f32,

    #[network(string)]
    #[codec(unity)]
    display_name: String,
}

§What it does

The attributes are inert markers. Applied to an item, they remove themselves and every Fomoxa attribute inside it, and hand back the item otherwise untouched — same fields, same types, same derives, same doc comments, same spans.

That removal is the entire implementation, and it exists for one narrow reason: Rust does not allow an attribute macro on a field, so #[network(u32)] cannot compile on its own. An attribute on the struct is what makes the ones on its fields legal, by consuming them.

So the annotated struct above compiles to exactly:

struct DeviceState {
    id: u32,
    temperature: f32,
    display_name: String,
}

§What it does not do

Everything else. There is no Reader, no Writer, no Encode, no Decode, no registry, no reflection, no dynamic dispatch, and no generated code of any kind. It reads no Fomoxa type, validates no annotation, and knows no codec name.

fomoxac reads the annotations out of your source, not out of this crate’s expansion, and every semantic question belongs to it:

  • Whether u32 names a Fomoxa type.
  • Whether a field declared u64 may carry #[network(u32)].
  • What edge or unity mean, and which fields each one covers.

On the last of those especially: a codec name is an identifier you invent. This crate has no list of them, no default, and no opinion — edge, unity, server, orange_pi are all the same to it, which is to say nothing at all.

§Scope

This crate is not a serialization runtime and not a networking library. It is two attributes and the code that takes them back off.

Attribute Macros§

codec
Marks a struct as taking part in codec generation, and declares which codec profiles a field belongs to.
network
Marks a struct as a Fomoxa network model, and declares the Fomoxa wire type of a field.