RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
rstudio::launcher_plugins::api::Mount Struct Reference

Struct which represents an file system mount available to a job. More...

#include <Job.hpp>

Public Member Functions

json::Object toJson () const
 Converts this Mount to a JSON object which represents it. More...
 

Static Public Member Functions

static Error fromJson (const json::Object &in_json, Mount &out_mount)
 Constructs a Mount from a JSON object which represents the mount. More...
 

Public Attributes

std::string Destination
 
bool IsReadOnly
 
MountSource Source
 

Detailed Description

Struct which represents an file system mount available to a job.

Member Function Documentation

◆ fromJson()

static Error rstudio::launcher_plugins::api::Mount::fromJson ( const json::Object in_json,
Mount out_mount 
)
static

Constructs a Mount from a JSON object which represents the mount.

Parameters
in_jsonThe JSON object which represents the mount.
out_mountThe populated mount value. Not valid if an error is returned.
Returns
Success if in_json could be parsed as a Mount; Error otherwise.

◆ toJson()

json::Object rstudio::launcher_plugins::api::Mount::toJson ( ) const

Converts this Mount to a JSON object which represents it.

Returns
The JSON object which represents this Mount.

Member Data Documentation

◆ Destination

std::string rstudio::launcher_plugins::api::Mount::Destination

The path to which to mount the source path.

◆ IsReadOnly

bool rstudio::launcher_plugins::api::Mount::IsReadOnly

Whether the mounted path is read only.

◆ Source

MountSource rstudio::launcher_plugins::api::Mount::Source

The source to mount.


The documentation for this struct was generated from the following file: