Struct LayerDefinition 

pub struct LayerDefinition { /* private fields */ }

Layer definition within a Feature Service.

ESRI Documentation

Source: https://developers.arcgis.com/rest/services-reference/enterprise/layer-feature-service/

Required properties:

• id: Layer ID (unique within service)
• name: Layer name
• geometryType: Type of geometry
• fields: Field definitions (must include an ObjectID field)

Implementations

impl LayerDefinition

Auto-generated by derive_getters::Getters.

pub fn id(&self) -> &u32

Layer ID (must be unique within service).

pub fn name(&self) -> &String

Layer name.

pub fn layer_type(&self) -> &Option<String>

Layer type.

Common value: “Feature Layer”. Other options: “Table”.

pub fn geometry_type(&self) -> &GeometryTypeDefinition

Geometry type for this layer.

pub fn fields(&self) -> &Vec<FieldDefinition>

Field definitions.

Must include at least an ObjectID field.

Note: When deserializing from the service root endpoint (GET {serviceUrl}?f=json), ESRI returns only layer stubs without field definitions. Use FeatureServiceClient::get_layer_definition() to retrieve full field definitions.

pub fn object_id_field(&self) -> &Option<String>

Name of the ObjectID field.

Default: “OBJECTID”. Must match a field in fields array.

pub fn global_id_field(&self) -> &Option<String>

Name of the GlobalID field.

When present, enables features that depend on globally unique identifiers such as offline sync and relationship tracking.

pub fn display_field(&self) -> &Option<String>

Display field name (shown in popups).

pub fn description(&self) -> &Option<String>

Layer description.

pub fn copyright_text(&self) -> &Option<String>

Copyright text.

pub fn default_visibility(&self) -> &Option<bool>

Default visibility.

Default: true.

pub fn templates(&self) -> &Vec<FeatureTemplate>

Templates for feature creation.

pub fn indexes(&self) -> &Vec<Index>

Indexes on layer fields.

ESRI automatically creates indexes on ObjectID and geometry fields. Additional indexes can improve query performance on frequently-queried fields.

pub fn edit_fields_info(&self) -> &Option<EditFieldsInfo>

Editor tracking field configuration.

Specifies which fields track creation and edit information.

pub fn relationships(&self) -> &Vec<LayerRelationship>

Relationship classes this layer participates in.

Each entry describes a relationship with another layer or table.

pub fn is_data_branch_versioned(&self) -> &Option<bool>

Whether data is branch versioned.

Read-only property returned by existing services. Branch versioning is configured through enterprise geodatabase administration, not through the REST API schema.

impl LayerDefinition

pub fn validate(&self) -> Result<(), Vec<ServiceDefinitionValidationError>>

Validates the layer definition against ESRI’s requirements.

Returns all validation errors found. An empty Ok(()) means the definition is valid and safe to submit to the ESRI API.

Validation Rules

• At least one FieldType::Oid field must be present
• Exactly one ObjectID field (not multiple)
• ObjectID field must have nullable: false and editable: false
• If is_data_branch_versioned is true, a FieldType::GlobalId field is required
• GlobalID field must have nullable: false and editable: false
• No duplicate field names (case-insensitive comparison)
• object_id_field, global_id_field, and display_field references must resolve

Example

use arcgis::{LayerDefinitionBuilder, FieldDefinitionBuilder, FieldType, GeometryTypeDefinition};

let field = FieldDefinitionBuilder::default()
    .name("OBJECTID")
    .field_type(FieldType::Oid)
    .nullable(false)
    .editable(false)
    .build()
    .expect("Valid field");

let layer = LayerDefinitionBuilder::default()
    .id(0u32)
    .name("Buildings")
    .geometry_type(GeometryTypeDefinition::Polygon)
    .build()
    .expect("Valid layer");

// Empty fields — will fail validation
assert!(layer.validate().is_err());

Trait Implementations

impl Clone for LayerDefinition

fn clone(&self) -> LayerDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LayerDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LayerDefinition

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LayerDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LayerDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.