iced_x86/block_enc/
enums.rs

1// SPDX-License-Identifier: MIT
2// Copyright (C) 2018-present iced project and contributors
3
4use crate::block_enc::iced_constants::IcedConstants;
5use crate::block_enc::iced_error::IcedError;
6use core::fmt;
7use core::iter::{ExactSizeIterator, FusedIterator, Iterator};
8
9// GENERATOR-BEGIN: RelocKind
10// ⚠️This was generated by GENERATOR!🦹‍♂️
11/// Relocation kind
12#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
13#[cfg_attr(not(feature = "exhaustive_enums"), non_exhaustive)]
14pub enum RelocKind {
15	/// 64-bit offset. Only used if it's 64-bit code.
16	Offset64 = 0,
17}
18#[rustfmt::skip]
19static GEN_DEBUG_RELOC_KIND: [&str; 1] = [
20	"Offset64",
21];
22impl fmt::Debug for RelocKind {
23	#[inline]
24	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
25		write!(f, "{}", GEN_DEBUG_RELOC_KIND[*self as usize])
26	}
27}
28impl Default for RelocKind {
29	#[must_use]
30	#[inline]
31	fn default() -> Self {
32		RelocKind::Offset64
33	}
34}
35#[allow(non_camel_case_types)]
36#[allow(dead_code)]
37pub(crate) type RelocKindUnderlyingType = ();
38#[rustfmt::skip]
39impl RelocKind {
40	/// Iterates over all `RelocKind` enum values
41	#[inline]
42	pub fn values() -> impl Iterator<Item = RelocKind> + DoubleEndedIterator + ExactSizeIterator + FusedIterator {
43		static VALUES: [RelocKind; 1] = [RelocKind::Offset64];
44		VALUES.iter().copied()
45	}
46}
47#[test]
48#[rustfmt::skip]
49fn test_relockind_values() {
50	let mut iter = RelocKind::values();
51	assert_eq!(iter.size_hint(), (IcedConstants::RELOC_KIND_ENUM_COUNT, Some(IcedConstants::RELOC_KIND_ENUM_COUNT)));
52	assert_eq!(iter.len(), IcedConstants::RELOC_KIND_ENUM_COUNT);
53	assert!(iter.next().is_some());
54	assert_eq!(iter.size_hint(), (IcedConstants::RELOC_KIND_ENUM_COUNT - 1, Some(IcedConstants::RELOC_KIND_ENUM_COUNT - 1)));
55	assert_eq!(iter.len(), IcedConstants::RELOC_KIND_ENUM_COUNT - 1);
56
57	let values: Vec<RelocKind> = RelocKind::values().collect();
58	assert_eq!(values.len(), IcedConstants::RELOC_KIND_ENUM_COUNT);
59	for (i, value) in values.into_iter().enumerate() {
60		assert_eq!(i, value as usize);
61	}
62
63	let values1: Vec<RelocKind> = RelocKind::values().collect();
64	let mut values2: Vec<RelocKind> = RelocKind::values().rev().collect();
65	values2.reverse();
66	assert_eq!(values1, values2);
67}
68#[rustfmt::skip]
69impl TryFrom<usize> for RelocKind {
70	type Error = IcedError;
71	#[inline]
72	fn try_from(value: usize) -> Result<Self, Self::Error> {
73		if value < IcedConstants::RELOC_KIND_ENUM_COUNT {
74			Ok(RelocKind::Offset64)
75		} else {
76			Err(IcedError::new("Invalid RelocKind value"))
77		}
78	}
79}
80#[test]
81#[rustfmt::skip]
82fn test_relockind_try_from_usize() {
83	for value in RelocKind::values() {
84		let converted = <RelocKind as TryFrom<usize>>::try_from(value as usize).unwrap();
85		assert_eq!(converted, value);
86	}
87	assert!(<RelocKind as TryFrom<usize>>::try_from(IcedConstants::RELOC_KIND_ENUM_COUNT).is_err());
88	assert!(<RelocKind as TryFrom<usize>>::try_from(core::usize::MAX).is_err());
89}
90#[cfg(feature = "serde")]
91#[rustfmt::skip]
92#[allow(clippy::zero_sized_map_values)]
93const _: () = {
94	use core::marker::PhantomData;
95	use serde::de;
96	use serde::{Deserialize, Deserializer, Serialize, Serializer};
97	type EnumType = RelocKind;
98	impl Serialize for EnumType {
99		#[inline]
100		fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
101		where
102			S: Serializer,
103		{
104			serializer.serialize_unit()
105		}
106	}
107	impl<'de> Deserialize<'de> for EnumType {
108		#[inline]
109		fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
110		where
111			D: Deserializer<'de>,
112		{
113			struct Visitor<'de> {
114				marker: PhantomData<EnumType>,
115				lifetime: PhantomData<&'de ()>,
116			}
117			impl<'de> de::Visitor<'de> for Visitor<'de> {
118				type Value = EnumType;
119				#[inline]
120				fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
121					formatter.write_str("enum RelocKind")
122				}
123				#[inline]
124				fn visit_unit<E>(self) -> Result<Self::Value, E>
125				where
126					E: de::Error,
127				{
128					Ok(RelocKind::Offset64)
129				}
130			}
131			deserializer.deserialize_unit(Visitor { marker: PhantomData::<EnumType>, lifetime: PhantomData })
132		}
133	}
134};
135// GENERATOR-END: RelocKind
136
137// GENERATOR-BEGIN: BlockEncoderOptions
138// ⚠️This was generated by GENERATOR!🦹‍♂️
139/// [`BlockEncoder`] options
140///
141/// [`BlockEncoder`]: struct.BlockEncoder.html
142#[allow(missing_copy_implementations)]
143#[allow(missing_debug_implementations)]
144pub struct BlockEncoderOptions;
145impl BlockEncoderOptions {
146	/// No option is set
147	pub const NONE: u32 = 0x0000_0000;
148	/// By default, branches get updated if the target is too far away, eg. `Jcc SHORT` -> `Jcc NEAR` or if 64-bit mode, `Jcc + JMP [RIP+mem]`. If this option is enabled, no branches are fixed.
149	pub const DONT_FIX_BRANCHES: u32 = 0x0000_0001;
150	/// The [`BlockEncoder`] should return [`RelocInfo`]s
151	///
152	/// [`BlockEncoder`]: struct.BlockEncoder.html
153	/// [`RelocInfo`]: struct.RelocInfo.html
154	pub const RETURN_RELOC_INFOS: u32 = 0x0000_0002;
155	/// The [`BlockEncoder`] should return new instruction offsets
156	///
157	/// [`BlockEncoder`]: struct.BlockEncoder.html
158	pub const RETURN_NEW_INSTRUCTION_OFFSETS: u32 = 0x0000_0004;
159	/// The [`BlockEncoder`] should return [`ConstantOffsets`]
160	///
161	/// [`BlockEncoder`]: struct.BlockEncoder.html
162	/// [`ConstantOffsets`]: struct.ConstantOffsets.html
163	pub const RETURN_CONSTANT_OFFSETS: u32 = 0x0000_0008;
164}
165// GENERATOR-END: BlockEncoderOptions
iced_x86/block_enc/enums.rs

iced_x86/block_enc/
enums.rs
