CCSDS Proximity-1 Space Link Protocol (211.0-B)
proximity1: rename get_frame_type, fix docs (merlint E331/E400/E410)
+4
-3
+2
-2
lib/proximity1.ml
+2
-2
lib/proximity1.ml
···
117
117
118
118
(* Staged getter for the frame-type bitfield — reads the first U16be word once
119
119
and extracts bits [4..6] with pure shift+mask. No manual Char.code needed. *)
120
-
let get_frame_type = Wire.Staged.unstage (Wire.Codec.get codec bf_frame_type)
120
+
let frame_type = Wire.Staged.unstage (Wire.Codec.get codec bf_frame_type)
121
121
122
122
let encode t =
123
123
let total = header_size + String.length t.data in
···
133
133
let total = Wire.Codec.wire_size_at codec buf 0 in
134
134
if len < total then Error `Truncated
135
135
else
136
-
let ft_bits = get_frame_type buf 0 in
136
+
let ft_bits = frame_type buf 0 in
137
137
match frame_type_of_int ft_bits with
138
138
| None -> Error (`Invalid_frame_type ft_bits)
139
139
| Some _ -> (
+1
-1
lib/proximity1.mli
+1
-1
lib/proximity1.mli
···
54
54
(** [compare a b] compares two frames for ordering. *)
55
55
56
56
val codec : t Wire.Codec.t
57
-
(** Wire codec for the full Proximity-1 frame (header + data). The codec models
57
+
(** [codec] is the Wire codec for the full Proximity-1 frame (header + data). It models
58
58
the complete frame: the 7-byte header followed by a variable-length data
59
59
field whose size is determined by the [frame_length] header field. *)
60
60