Struct dfhack_proto::messages::Item

pub struct Item {
    pub pos: SingularPtrField<Coord>,
    pub field_type: SingularPtrField<MatPair>,
    pub material: SingularPtrField<MatPair>,
    pub dye: SingularPtrField<ColorDefinition>,
    pub improvements: RepeatedField<ItemImprovement>,
    pub image: SingularPtrField<ArtImage>,
    pub unknown_fields: UnknownFields,
    pub cached_size: CachedSize,
    /* private fields */
}

Fields

pos: SingularPtrField<Coord>

field_type: SingularPtrField<MatPair>

material: SingularPtrField<MatPair>

dye: SingularPtrField<ColorDefinition>

improvements: RepeatedField<ItemImprovement>

image: SingularPtrField<ArtImage>

unknown_fields: UnknownFields

cached_size: CachedSize

Implementations

impl Item

pub fn new() -> Item

pub fn get_id(&self) -> i32

pub fn clear_id(&mut self)

pub fn has_id(&self) -> bool

pub fn set_id(&mut self, v: i32)

pub fn get_pos(&self) -> &Coord

pub fn clear_pos(&mut self)

pub fn has_pos(&self) -> bool

pub fn set_pos(&mut self, v: Coord)

pub fn mut_pos(&mut self) -> &mut Coord

pub fn take_pos(&mut self) -> Coord

pub fn get_flags1(&self) -> u32

pub fn clear_flags1(&mut self)

pub fn has_flags1(&self) -> bool

pub fn set_flags1(&mut self, v: u32)

pub fn get_flags2(&self) -> u32

pub fn clear_flags2(&mut self)

pub fn has_flags2(&self) -> bool

pub fn set_flags2(&mut self, v: u32)

pub fn get_field_type(&self) -> &MatPair

pub fn clear_field_type(&mut self)

pub fn has_field_type(&self) -> bool

pub fn set_field_type(&mut self, v: MatPair)

pub fn mut_field_type(&mut self) -> &mut MatPair

pub fn take_field_type(&mut self) -> MatPair

pub fn get_material(&self) -> &MatPair

pub fn clear_material(&mut self)

pub fn has_material(&self) -> bool

pub fn set_material(&mut self, v: MatPair)

pub fn mut_material(&mut self) -> &mut MatPair

pub fn take_material(&mut self) -> MatPair

pub fn get_dye(&self) -> &ColorDefinition

pub fn clear_dye(&mut self)

pub fn has_dye(&self) -> bool

pub fn set_dye(&mut self, v: ColorDefinition)

pub fn mut_dye(&mut self) -> &mut ColorDefinition

pub fn take_dye(&mut self) -> ColorDefinition

pub fn get_stack_size(&self) -> i32

pub fn clear_stack_size(&mut self)

pub fn has_stack_size(&self) -> bool

pub fn set_stack_size(&mut self, v: i32)

pub fn get_subpos_x(&self) -> f32

pub fn clear_subpos_x(&mut self)

pub fn has_subpos_x(&self) -> bool

pub fn set_subpos_x(&mut self, v: f32)

pub fn get_subpos_y(&self) -> f32

pub fn clear_subpos_y(&mut self)

pub fn has_subpos_y(&self) -> bool

pub fn set_subpos_y(&mut self, v: f32)

pub fn get_subpos_z(&self) -> f32

pub fn clear_subpos_z(&mut self)

pub fn has_subpos_z(&self) -> bool

pub fn set_subpos_z(&mut self, v: f32)

pub fn get_projectile(&self) -> bool

pub fn clear_projectile(&mut self)

pub fn has_projectile(&self) -> bool

pub fn set_projectile(&mut self, v: bool)

pub fn get_velocity_x(&self) -> f32

pub fn clear_velocity_x(&mut self)

pub fn has_velocity_x(&self) -> bool

pub fn set_velocity_x(&mut self, v: f32)

pub fn get_velocity_y(&self) -> f32

pub fn clear_velocity_y(&mut self)

pub fn has_velocity_y(&self) -> bool

pub fn set_velocity_y(&mut self, v: f32)

pub fn get_velocity_z(&self) -> f32

pub fn clear_velocity_z(&mut self)

pub fn has_velocity_z(&self) -> bool

pub fn set_velocity_z(&mut self, v: f32)

pub fn get_volume(&self) -> i32

pub fn clear_volume(&mut self)

pub fn has_volume(&self) -> bool

pub fn set_volume(&mut self, v: i32)

pub fn get_improvements(&self) -> &[ItemImprovement]

pub fn clear_improvements(&mut self)

pub fn set_improvements(&mut self, v: RepeatedField<ItemImprovement>)

pub fn mut_improvements(&mut self) -> &mut RepeatedField<ItemImprovement>

pub fn take_improvements(&mut self) -> RepeatedField<ItemImprovement>

pub fn get_image(&self) -> &ArtImage

pub fn clear_image(&mut self)

pub fn has_image(&self) -> bool

pub fn set_image(&mut self, v: ArtImage)

pub fn mut_image(&mut self) -> &mut ArtImage

pub fn take_image(&mut self) -> ArtImage

Trait Implementations

impl Clear for Item

fn clear(&mut self)

Clear this make, make it equivalent to newly created object.

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl Default for Item

fn default() -> Item

Returns the “default value” for a type.

impl<'a> Default for &'a Item

fn default() -> &'a Item

Returns the “default value” for a type.

impl Message for Item

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> ProtobufResult<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u32

Compute and cache size of this message and all nested messages

fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> ProtobufResult<()>

Write message to the stream.

fn get_cached_size(&self) -> u32

Get size previously computed by compute_size.

fn get_unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

fn as_any(&self) -> &dyn Any

View self as Any.

fn as_any_mut(&mut self) -> &mut dyn Any

View self as mutable Any.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Convert boxed self to boxed Any.

fn descriptor(&self) -> &'static MessageDescriptor

Message descriptor for this message, used for reflection.

fn new() -> Item

Create an empty message object.

fn descriptor_static() -> &'static MessageDescriptor

Get message descriptor for message type.

fn default_instance() -> &'static Item

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, ProtobufError>

Parse message from stream.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), ProtobufError>

Write the message to the stream.

fn write_length_delimited_to(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<(), ProtobufError>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(
    &self,
    vec: &mut Vec<u8, Global>
) -> Result<(), ProtobufError>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), ProtobufError>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, ProtobufError>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, ProtobufError>

Parse message from byte array.

fn check_initialized(&self) -> Result<(), ProtobufError>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), ProtobufError>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8, Global>) -> Result<(), ProtobufError>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8, Global>, ProtobufError>

Write the message to bytes vec.

fn write_length_delimited_to_writer(
    &self,
    w: &mut dyn Write
) -> Result<(), ProtobufError>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(
    &self
) -> Result<Vec<u8, Global>, ProtobufError>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn type_id(&self) -> TypeId

Get type id for downcasting.

impl PartialEq<Item> for Item

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl ProtobufValue for Item

fn as_ref(&self) -> ReflectValueRef<'_>

As ref

fn as_any(&self) -> &(dyn Any + 'static)

Convert to Any

fn is_non_zero(&self) -> bool

Is value non-zero?

fn as_ref_copy(&self) -> ReflectValueRef<'static>

Return ProtobufValueRef if self is Copy.

impl StructuralPartialEq for Item