Struct Layout 

pub struct Layout { /* private fields */ }

A parsed storage layout.

Implementations

impl Layout

pub fn from_json(s: &str) -> Result<Self>

Accepts either a bare storageLayout object or a whole forge/hardhat artifact that contains one.

pub fn from_artifact(path: impl AsRef<Path>) -> Result<Self>

Layout::from_json on the contents of path.

pub fn fields(&self) -> impl Iterator<Item = &StorageEntry>

Top-level variables in declaration order.

pub fn locate(&self, path: &str) -> Result<Location>

Resolve a dotted/indexed path to its storage location.

pub fn decode(&self, loc: &Location, word: B256) -> Value

Decode the value at loc out of a full 32-byte storage word.

pub fn kind_of(&self, path: &str) -> Result<PathKind>

What kind of thing a path names — a leaf value, or a container that takes another path segment. Drives the Node view proxy.

pub fn decode_typed(&self, loc: &Location, word: B256) -> (ValueKind, Value)

Decode with an explicit kind, so callers that marshal across a language boundary know what the text is.

pub fn typescript(&self, name: &str) -> String

TypeScript declaration of the contract’s storage as the Node view exposes it: bigint for integers, boolean, string for addresses and bytes, nested objects for structs, index signatures for mappings and arrays. name is the interface name.

pub fn describe_slot( &self, slot: B256, array_probe: u64, ) -> Vec<(String, Location)>

Human name(s) for a raw slot: top-level values, struct members, and dynamic-array elements within array_probe slots of the data start. Mapping entries cannot be named without a candidate key.