aivi.clipboard

Application data types for clipboard. This module supplies vocabulary only: it does not load data, watch sources, or implement the task aliases it defines.

Import

use aivi.clipboard (
    ClipboardError
    ClipboardContent
    ClipboardTask
    ClipboardWriteTask
)

Overview

Item	Type	Description
ClipboardError	type	Things that can go wrong when reading or writing clipboard data
ClipboardContent	type	Tagged clipboard contents: text, URIs, image bytes, HTML, or empty
ClipboardTask A	Task ClipboardError A	Task alias for clipboard-related work
ClipboardWriteTask	Task ClipboardError Unit	Task alias for clipboard writes

Types

ClipboardError

type ClipboardError =
  | ClipboardUnavailable
  | ClipboardEmpty
  | ClipboardTypeMismatch Text
  | ClipboardWriteFailed Text

These variants explain why clipboard access failed.

• ClipboardUnavailable — no clipboard service is available
• ClipboardEmpty — the clipboard currently has no value to read
• ClipboardTypeMismatch — the clipboard has data, but not in the form you expected
• ClipboardWriteFailed — a write attempt failed with a message from the backend

ClipboardContent

type ClipboardContent =
  | TextContent Text
  | UriListContent (List Text)
  | ImageContent Bytes
  | HtmlContent Text
  | EmptyClipboard

ClipboardContent is a tagged value, so you always know what kind of data the clipboard is holding before you try to use it.

• TextContent — plain text
• UriListContent — one or more copied URIs, such as file paths or links
• ImageContent — raw image bytes
• HtmlContent — formatted HTML text
• EmptyClipboard — an explicit empty state

use aivi.clipboard (
    ClipboardContent
    TextContent
    UriListContent
    ImageContent
    HtmlContent
    EmptyClipboard
)

type ClipboardContent -> Text
func clipboardSummary =
 ||> TextContent text    -> text
 ||> UriListContent uris -> "Copied links"
 ||> ImageContent bytes  -> "Copied image"
 ||> HtmlContent html    -> "Copied rich text"
 ||> EmptyClipboard      -> "Clipboard is empty"

ClipboardTask

use aivi.clipboard (ClipboardError)

type ClipboardTask A = (Task ClipboardError A)

Convenience name for clipboard operations that may fail with ClipboardError.

ClipboardWriteTask

use aivi.clipboard (ClipboardError)

type ClipboardWriteTask = (Task ClipboardError Unit)

Convenience name for clipboard write operations.

At the time of writing, this module does not export a concrete write function. The alias is still useful because it documents the task shape other clipboard APIs are expected to use.

Clipboard text source

The GTK bridge implements clipboard.changed, which publishes text:

@source clipboard.changed
signal clipboardText : Signal Text

It does not publish ClipboardContent or support the richer content variants above.

Task alias

ClipboardTask A is Task ClipboardError A, used by clipboard reads and other operations that return a value.