class Symlink
Defined at line 17850 of file fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/hlcpp/fuchsia/io/cpp/fidl.h
A ['Node'] which contains a symbolic link.
Public Members
static const char[] Name_Public Methods
void ~Symlink ()void LinkInto (::zx::event dst_parent_token, ::std::string dst, LinkIntoCallback callback)Creates a link to this this object with name `dst` in the directory represented by
`dst_parent_token`.
`dst` must be a resolved object name. Including "/" in the string will return
`ZX_ERR_INVALID_ARGS`.
This method requires the maximal set of rights supported by the filesystem for this object.
For files this would typically be [`Rights.READ_BYTES`], [`Rights.WRITE_BYTES`],
[`Rights.GET_ATTRIBUTES`] and [`Rights.UPDATE_ATTRIBUTES`]. Some filesystems might also
support the [`Rights.EXECUTE`] right. Insufficient rights will result in
`ZX_ERR_ACCESS_DENIED`.
If this object has no links and is *NOT* an unnamed temporary object (objects opened with
`Flags.FLAG_CREATE_AS_UNNAMED_TEMPORARY`), it will fail with `ZX_ERR_NOT_FOUND`.
For unnamed temporary objects, use LinkInto to give it a name. Upon successful completion,
the object will be permanently linked to the filesystem. Requires that the unnamed temporary
object is linkable, if not, it will fail with `ZX_ERR_NOT_FOUND`.
This method does not have the same atomicity properties has the `Directory::Link` method,
which means that calling `Open` then `LinkInto` is not equivalent to `Directory::Link`
because `LinkInto` will not prevent the source from being renamed or unlinked.
void Clone (::fidl::InterfaceRequest< ::fuchsia::unknown::Cloneable> request)void Close (CloseCallback callback)Terminates the connection.
After calling `Close`, the client must not send any other requests.
Servers, after sending the status response, should close the connection
regardless of status and without sending an epitaph.
Closing the client end of the channel should be semantically equivalent
to calling `Close` without knowing when the close has completed or its
status.
void Query (QueryCallback callback)void DeprecatedClone (::fuchsia::io::OpenFlags flags, ::fidl::InterfaceRequest< ::fuchsia::io::Node> object)DEPRECATED - Use `fuchsia.unknown/Cloneable.Clone` instead.
void DeprecatedGetAttr (DeprecatedGetAttrCallback callback)DEPRECATED - Use `Node.GetAttributes` instead.
void DeprecatedSetAttr (::fuchsia::io::NodeAttributeFlags flags, ::fuchsia::io::NodeAttributes attributes, DeprecatedSetAttrCallback callback)DEPRECATED - Use `Node.UpdateAttributes` instead.
void DeprecatedGetFlags (DeprecatedGetFlagsCallback callback)[DEPRECATED - Use new GetFlags method instead.]
void DeprecatedSetFlags (::fuchsia::io::OpenFlags flags, DeprecatedSetFlagsCallback callback)[DEPRECATED - Use new SetFlags method instead.]
void GetFlags (GetFlagsCallback callback)Queries the flags that apply to this node after it has been opened/created. This method does
not require any rights.
Note that the final set of flags that apply to the connection may differ from those
specified with the `fuchsia.io/Directory.Open` request used to create it:
- `Flags.PERM_INHERIT_*`: Only applies when determining connection rights.
- `Flags.PROTOCOL_*`: Only the protocol of the connection will be present.
- `Flags.FLAG_*`: Only applies when opening the resource, not part of the connection.
void SetFlags (::fuchsia::io::Flags flags, SetFlagsCallback callback)Sets the flags that apply to this node after it has been opened. This method does not
require any rights.
Only `Flags.FILE_APPEND` is currently supported. Calling this method without any flags will
clear append mode.
Errors:
- `ZX_ERR_NOT_SUPPORTED`: The object does not support this feature or the specified flags.
- `ZX_ERR_INVALID_ARGS`: `flags` other than `Flags.FILE_APPEND` were specified.
void QueryFilesystem (QueryFilesystemCallback callback)Query the filesystem for details specific to the filesystem and/or volume. If the current
volume has different settings or the storage is accounted seperately from the rest of the
filesystem that may be reported instead of filesystem-wide details.
void GetAttributes (::fuchsia::io::NodeAttributesQuery query, GetAttributesCallback callback)Acquires information about the node.
The attributes of a node should be stable, independent of the
specific protocol used to access it.
If a particular attribute is not applicable or not supported,
filesystems should leave the corresponding field absent.
+ `query` a bit-mask specifying which attributes to fetch. The server
should not return more than necessary.
- `attributes` the returned attributes.
This method requires the [`Rights.GET_ATTRIBUTES`] right.
void UpdateAttributes (::fuchsia::io::MutableNodeAttributes MutableNodeAttributes, UpdateAttributesCallback callback)Updates information about the node.
+ `attributes` the presence of a table field in `attributes` indicates
the intent to update the corresponding attribute.
Returns `ZX_ERR_NOT_SUPPORTED` if the node does not support any of the specified attributes.
This method requires the [`Rights.UPDATE_ATTRIBUTES`] right.
void Sync (SyncCallback callback)Synchronizes updates to the node to the underlying media, if it exists.
This method will return when the filesystem server has flushed the
relevant updates to the underlying media, but does not guarantee the
underlying media has persisted the information, nor that any information
is committed to hardware. Clients may use `Sync` to ensure ordering
between operations.
This method does not require any rights.
void ListExtendedAttributes (::fidl::InterfaceRequest< ::fuchsia::io::ExtendedAttributeIterator> iterator)Creates an iterator over all the extended attribute names associated
with this node. If an error occurs it is returned as an epitaph on the
iterator request channel, and then the channel is closed.
GetExtendedAttributes can be used with any of these names to retrieve
the associated value.
This method requires the [`Rights.GET_ATTRIBUTES`] right.
void GetExtendedAttribute (::std::vector<uint8_t> name, GetExtendedAttributeCallback callback)Get the value associated with the given attribute `name` for this node.
Attribute names have a maximum length of MAX_ATTRIBUTE_NAME. No
particular structure is imposed on them.
This method requires the [`Rights.GET_ATTRIBUTES`] right.
void SetExtendedAttribute (::std::vector<uint8_t> name, ::fuchsia::io::ExtendedAttributeValue value, ::fuchsia::io::SetExtendedAttributeMode mode, SetExtendedAttributeCallback callback)Set the value for the given attribute `name` to `value` for this node.
The attribute name may exist, in which case the attribute is updated.
If the attribute doesn't exist, it is created. The name should have no
null bytes in it. If it does, ZX_ERR_INVALID_ARGS is returned.
This method requires the [`Rights.UPDATE_ATTRIBUTES`] right.
void RemoveExtendedAttribute (::std::vector<uint8_t> name, RemoveExtendedAttributeCallback callback)Remove the specified extended attribute.
If the attribute doesn't exist, ZX_ERR_NOT_FOUND is returned.
This method requires the [`Rights.UPDATE_ATTRIBUTES`] right.
void Describe (DescribeCallback callback)Protected Methods
void handle_unknown_method (uint64_t ordinal, bool method_has_response)Friends
class Symlink_Stub