Home

Symbolic Link

This is a lightweight representation of a symbolic link as a directory entry, distinct from the file or directory that the link may point to.

Keeping symbolic links explicit prevents graph and workspace tooling from silently dereferencing paths and reading content outside the workspace under a local-looking path. The path property identifies the link entry itself, while target preserves the target spelling stored by the filesystem. That target may be relative, absolute, missing, or outside the workspace; callers that need to resolve it should do so deliberately and record any relationship separately.

Properties

The SymbolicLink type has these properties:

NameDescriptionTypeInherited from
nameThe name of the symbolic link.String-
pathThe path (absolute or relative) of the symbolic link on the file system.String-
targetThe raw target path stored by the symbolic link.String-
idThe identifier for this item.StringEntity

Related

The SymbolicLink type is related to these types:

Bindings

The SymbolicLink type is represented in:


This documentation was generated from SymbolicLink.yaml by docs_types.rs.

© 2026 Stencila