Enum TagPath

pub enum TagPath {
    Controller {
        tag_name: String,
    },
    Program {
        program_name: String,
        tag_name: String,
    },
    Array {
        base_path: Box<TagPath>,
        indices: Vec<u32>,
    },
    Bit {
        base_path: Box<TagPath>,
        bit_index: u8,
    },
    Member {
        base_path: Box<TagPath>,
        member_name: String,
    },
    StringLength {
        base_path: Box<TagPath>,
    },
    StringData {
        base_path: Box<TagPath>,
        index: u32,
    },
}

Represents different types of tag addressing supported by Allen-Bradley PLCs

Variants

Controller

Simple controller-scoped tag: “MyTag”

Fields

tag_name: String

Program

Program-scoped tag: “Program:MainProgram.MyTag”

Fields

program_name: String

tag_name: String

Array

Array element access: “MyArray[5]” or “MyArray[1,2,3]”

Fields

base_path: Box<TagPath>

indices: Vec<u32>

Bit

Bit access within a tag: “MyDINT.15”

Fields

base_path: Box<TagPath>

bit_index: u8

Member

UDT member access: “MyUDT.Member1”

Fields

base_path: Box<TagPath>

member_name: String

StringLength

String length access: “MyString.LEN”

Fields

base_path: Box<TagPath>

StringData

String data access: “MyString.DATA[5]”

Fields

base_path: Box<TagPath>

index: u32

Implementations

impl TagPath

pub fn parse(path_str: &str) -> Result<Self>

Parses a tag path string into a structured TagPath

Examples

use rust_ethernet_ip::TagPath;
 
// Simple controller tag
let path = TagPath::parse("MyTag")?;
 
// Program-scoped tag
let path = TagPath::parse("Program:MainProgram.MyTag")?;
 
// Array element
let path = TagPath::parse("MyArray[5]")?;
 
// Multi-dimensional array
let path = TagPath::parse("Matrix[1,2,3]")?;
 
// Bit access
let path = TagPath::parse("StatusWord.15")?;
 
// UDT member
let path = TagPath::parse("MotorData.Speed")?;
 
// Complex nested path
let path = TagPath::parse("Program:Safety.Devices[2].Status.15")?;

pub fn to_string(&self) -> String

Converts the TagPath back to a string representation

pub fn to_cip_path(&self) -> Result<Vec<u8>>

Generates the CIP path bytes for this tag path

This converts the structured tag path into the binary format required by the CIP protocol for EtherNet/IP communication.

pub fn base_tag_name(&self) -> String

Returns the base tag name without any path qualifiers

pub fn is_program_scoped(&self) -> bool

Returns true if this is a program-scoped tag

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

Returns the program name if this is a program-scoped tag

Trait Implementations

impl Clone for TagPath

fn clone(&self) -> TagPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TagPath

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

Formats the value using the given formatter.

impl Display for TagPath

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

Formats the value using the given formatter.

impl PartialEq for TagPath

fn eq(&self, other: &TagPath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TagPath