{% extends "base.html" %} {% block title %}{{ namespace.name }}.{{ struct.name }}{% endblock %} {% block meta_other %} {% endblock %} {% macro sidebar_block(elements, struct_name, section_title, section_class, section_fragment) -%} {% if elements|length > 0 %}
{{ section_title }}
{% endif %} {% endmacro %} {% block sidebar %}
Type
{% for section in sections %} {{ sidebar_block(section.index, struct.name, section.title, section.section_class, section.section_fragment) }} {% endfor %} {% endblock %} {% macro navbar_block(elements, section_title, section_link) -%} {% if elements|length > 0 %}
  • {{ section_title }}
  • {% endif %} {% endmacro %} {% block navbar %}
    {% endblock %} {% block content %}

    Struct

    {{ namespace.name }}{{ struct.name }}

    {%- if CONFIG.is_unstable(struct.available_since) -%} unstable  {%- endif %} {%- if struct.deprecated_since -%} deprecated: {{ struct.deprecated_since.version }}  {%- endif -%} {%- if struct.available_since -%} since: {{ struct.available_since }} {%- endif -%}

    Description {% if CONFIG.source_location_url and struct.docs_location %} [src] {% endif %}

    {{ struct.c_decl }}
    {{ struct.description }}
    {% if struct.fields %}
    Structure members {% if CONFIG.source_location_url and struct.source_location %} [src] {% endif %}
    {% for field in struct.fields %}
    {{ field.name }}
    {{ field.description }}
    {% endfor %}
    {% endif %}
    {% if struct.stability %}

    Stability: {{ struct.stability }}

    {% endif %} {% if struct.available_since %}

    Available since: {{ struct.available_since }}

    {% endif %} {% if struct.deprecated_since %}

    Deprecated since: {{ struct.deprecated_since.version }}.

    {%- if struct.deprecated_since.message -%} {{ struct.deprecated_since.message }} {%- else -%}

    Do not use in newly written code.

    {%- endif -%}
    {% endif %}
    {% if struct.attributes %}
    {% for (key, value) in struct.attributes.items()|sort %} {% endfor %}
    {{ key|escape }}{{ value|escape }}
    {% endif %}
    {% if struct.ctors %}

    Constructors

    {% for ctor in struct.ctors %}
    {{ ctor.identifier }}
    {{ ctor.summary }}

    {%- if CONFIG.is_unstable(ctor.available_since) -%} unstable  {%- endif %} {%- if ctor.deprecated_since -%} deprecated: {{ ctor.deprecated_since }}  {%- endif -%} {%- if ctor.available_since -%} since: {{ ctor.available_since }} {%- endif -%}

    {% endfor %}
    {% endif %} {% if struct.type_funcs %}

    Functions

    {% for func in struct.type_funcs %}
    {{ func.identifier }}
    {{ func.summary }}

    {%- if CONFIG.is_unstable(func.available_since) -%} unstable  {%- endif %} {%- if func.deprecated_since -%} deprecated: {{ func.deprecated_since }}  {%- endif -%} {%- if func.available_since -%} since: {{ func.available_since }} {%- endif -%}

    {% endfor %}
    {% endif %} {% if struct.methods %}

    Instance methods

    {% for method in struct.methods %}
    {{ method.identifier }}
    {{ method.summary }}

    {%- if CONFIG.is_unstable(method.available_since) -%} unstable  {%- endif %} {%- if method.deprecated_since -%} deprecated: {{ method.deprecated_since }}  {%- endif -%} {%- if method.available_since -%} since: {{ method.available_since }} {%- endif -%}

    {% endfor %}
    {% endif %}
    {% endblock %}