docs(ir): clarify localness of socketidx

This commit is contained in:
multisn8 2024-01-19 14:34:00 +01:00
parent cdf42417da
commit 8b6f9810df
Signed by untrusted user: multisamplednight
GPG key ID: 6D525AA147CBDAE2

View file

@ -58,6 +58,13 @@ pub struct Socket {
pub idx: SocketIdx, pub idx: SocketIdx,
} }
/// Where a [`Socket`] is on an **instruction**. /// Where a [`Socket`] is on one **instruction**.
///
/// Note that this does **not** identify a [`Socket`] globally.
/// There may be multiple [`Socket`]s sharing the same [`SocketIdx`],
/// but on different [`Instruction`]s.
///
/// This really only serves for denoting where a socket is,
/// when it's already clear which instruction is referred to.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)] #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub struct SocketIdx(pub u16); pub struct SocketIdx(pub u16);