Skip to content

Document the structs in the embedder API that are sealed. #38470

Closed

Description

@chinmaygarde

This can be done via comments in the header. Most structs are safe to modify by appending members at the end of the struct. However, some are not (these are the ones without struct_size or the ones that are non-pointer union members in other structs.)

Activity

  1. added
    engineflutter/engine related. See also e: labels.
    e: embedderUsers of the Embedder API
    on Aug 13, 2019
  2. stuartmorgan-g commented on Aug 13, 2019

    @stuartmorgan-g
    Contributor

    We could also unit-test them for added assurance (e.g., have a test that asserts that the address of the first member plus the size of the struct is the same as the address of the expected last member plus the size of that member).

  3. added
    P3Issues that are less important to the Flutter project
    on Dec 9, 2020
  4. added
    d: api docsIssues with https://api.flutter.dev/
    on Jul 5, 2023
  5. loic-sharma commented on Apr 20, 2026

    @loic-sharma
    Member

    We could also unit-test them for added assurance (e.g., have a test that asserts that the address of the first member plus the size of the struct is the same as the address of the expected last member plus the size of that member).

    This bit was added by:

    1. [Embedder API] Freeze parts of API for ABI stability flutter-team-archive/engine#39963
    2. [Embedder API] Lock nested structs for ABI stability flutter-team-archive/engine#40069

    I'll leave this open as we should do a pass to verify all sealed structs are documented.

  6. loic-sharma commented on Oct 16, 2026

    @loic-sharma
    Member

    Done by #186842

  7. github-actions commented on Oct 30, 2026

    @github-actions

    This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

  8. locked as resolved and limited conversation to collaborators on Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Issues that are less important to the Flutter projectd: api docsIssues with https://api.flutter.dev/e: embedderUsers of the Embedder APIengineflutter/engine related. See also e: labels.team-engineOwned by Engine teamtriaged-engineTriaged by Engine team

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions