ifgen.struct.methods package

Subpackages

• ifgen.struct.methods.fields package
  • Submodules
  • ifgen.struct.methods.fields.common module
    • bit_field_method_slug()
    • bit_field_underlying()
    • bit_mask_literal()
    • possible_array_arg()
  • ifgen.struct.methods.fields.getter module
    • bit_field_get_all_method()
    • bit_field_get_method()
    • get_bit_field_statement()
  • ifgen.struct.methods.fields.setter module
    • bit_field_set_all_method()
    • bit_field_set_lines()
    • bit_field_set_method()
  • Module contents
    • bit_field()
    • bit_fields()
    • handle_atomic_fields_methods()

Submodules

ifgen.struct.methods.bit module

A module implementing interfaces for generating bit-field methods.

ifgen.struct.methods.bit.bit_field_toggle_method(task: GenerateTask, name: str, field: dict[str, Any], writer: IndentedFileWriter, header: bool, method_slug: str) → None

Generate a ‘toggle’ method for a bit-field.

ifgen.struct.methods.bit.clear_bit_method(task: GenerateTask, name: str, field: dict[str, Any], writer: IndentedFileWriter, header: bool, method_slug: str) → None

Generate a ‘clear’ method for a bit-field.

ifgen.struct.methods.bit.handle_description(writer: IndentedFileWriter, field: dict[str, Any]) → None

Handle writing an instance’s description.

ifgen.struct.methods.bit.set_bit_method(task: GenerateTask, name: str, field: dict[str, Any], writer: IndentedFileWriter, header: bool, method_slug: str) → None

Generate a ‘set’ method for a bit-field.

ifgen.struct.methods.common module

Utilities shared between struct methods.

ifgen.struct.methods.common.native_decode(writer: IndentedFileWriter) → None

Write a buffer decoding method for native byte order.

ifgen.struct.methods.common.native_encode(writer: IndentedFileWriter) → None

Write a buffer encoding method for native byte order.

ifgen.struct.methods.common.wrapper_method(task: GenerateTask, writer: IndentedFileWriter, header: bool, is_encode: bool = True) → None

Create a generic encode/decode method.

ifgen.struct.methods.decode module

A module for struct-decoding methods.

ifgen.struct.methods.decode.decode_method(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Write boilerplate decode method.

ifgen.struct.methods.decode.struct_decode(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Add a method for decoding structs.

ifgen.struct.methods.encode module

A module for struct-encoding methods.

ifgen.struct.methods.encode.encode_method(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Write boilerplate encode method.

ifgen.struct.methods.encode.struct_encode(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Add a method for encoding structs.

ifgen.struct.methods.swap module

A module implementing interfaces for byte-swapping method generation.

ifgen.struct.methods.swap.assignment(writer: IndentedFileWriter, lhs: str, rhs: str) → None

Write an assignment line.

ifgen.struct.methods.swap.decode_primitive_swap(field: dict[str, Any], writer: IndentedFileWriter, is_array: bool) → None

Decode a primitive-sized element by swapping byte order.

ifgen.struct.methods.swap.decode_swapped_method(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Generate a struct-decode method that uses swapped byte order.

ifgen.struct.methods.swap.encode_primitive_swap(field: dict[str, Any], writer: IndentedFileWriter, is_array: bool) → None

Encode a primitive-sized element by swapping byte order.

ifgen.struct.methods.swap.encode_swapped_method(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Generate a struct-encode method that uses swapped byte order.

ifgen.struct.methods.swap.no_swap(field: dict[str, Any], is_decode: bool, task: GenerateTask, writer: IndentedFileWriter, is_array: bool) → None

Encode or decode a single-byte type.

ifgen.struct.methods.swap.swap_enum(field: dict[str, Any], is_decode: bool, task: GenerateTask, writer: IndentedFileWriter, is_array: bool) → None

Perform a byte swap for an enumeration type.

ifgen.struct.methods.swap.swap_fields(task: GenerateTask, writer: IndentedFileWriter, is_decode: bool = True) → None

Perform byte swaps on individual struct fields.

ifgen.struct.methods.swap.swap_struct(field: dict[str, Any], is_decode: bool, task: GenerateTask, writer: IndentedFileWriter, is_array: bool) → None

Perform a byte swap for a struct type.

ifgen.struct.methods.swap.to_integral(kind: str) → str

Convert certain types to their corresponding integral types.

Module contents

A module implementing interfaces for generating struct method code.

ifgen.struct.methods.protocol_json(task: GenerateTask) → dict[str, Any]

Get JSON data for this struct task.

ifgen.struct.methods.span_method(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Generate a span method.

ifgen.struct.methods.struct_buffer_method(task: GenerateTask, writer: IndentedFileWriter, header: bool, read_only: bool) → None

Generate a method for raw buffer access.

ifgen.struct.methods.struct_methods(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Write generated-struct methods.

ifgen.struct.methods.swap_method(task: GenerateTask, writer: IndentedFileWriter, header: bool) → None

Add an in-place swap method.