files

Documentation

Index

• type RMFileInfo
  • func RMFiler(inputpath string, template string) (RMFileInfo, error)
  • func (r *RMFileInfo) Debug(d string)
• type RMPage

Types

type RMFileInfo

type RMFileInfo struct {
	RelPDFPath   string // full relative path to PDF
	Identifier   string // the uuid used to identify the PDF file
	Version      int    // version from metadata
	VisibleName  string // visibleName from metadata (used in reMarkable interface)
	LastModified time.Time
	PageCount    int
	Pages        []RMPage
	UseTemplate  bool // a template pdf is in use
	Debugging    bool
}

struct defining the collected metadata about a PDF from the reMarkable file collection

func RMFiler

func RMFiler(inputpath string, template string) (RMFileInfo, error)

RMFiler collects information from the reMarkable files associated with the uuid of interest. Either a pdf at <path/uuid.pdf> is expected, or a single A4 page template is to be provided instead. The uuid (identified by its filepath plus <uuid>), is used to collect information from the .metadata and .content files. It then collects layer information for each associated .rm file in a directory named by the uuid of the pdf.

func (*RMFileInfo) Debug

func (r *RMFileInfo) Debug(d string)

type RMPage

type RMPage struct {
	PageNo     int
	Identifier string   // the uuid used to identify the RM file
	RelRMPath  string   // full relative path to the .rm file
	Exists     bool     // file exists on disk
	LayerNames []string // layer names by implicit index
}

Struct defining metadata about each .rm file associated with the PDF described in an RMFileInfo. Note that while the .content file records page UUIDs for each page of the original PDF, .rm and related file are only made for those pages which have marks