Skip to content

Allow customizing the HELP reply - #609

Open
TTurletti wants to merge 1 commit into
Cloudinvoke:masterfrom
TTurletti:configurable-help-text
Open

TTurletti wants to merge 1 commit into
Cloudinvoke:masterfrom
TTurletti:configurable-help-text

Conversation

@TTurletti

@TTurletti TTurletti commented Nov 16, 2026 •

Copy link
Copy Markdown

Closes #608.

The HELP reply names the library and its exact version to any client, and there was no way to change it. This adds ServerBuilder::help_text, next to greeting(), to set the lines of the 214 reply:

ServerBuilder::new(...)
    .help_text(["The following commands are recognized.", "Help OK."])
  • Without it, the reply is unchanged.
  • The lines are passed down to the HELP handler the same way as the greeting (Server → OptionsHolder → control loop config → PrimaryEventHandler), shared through an Arc<[String]>.
  • tests/help.rs checks both the default reply and a custom one, over a real control connection.
  • CHANGELOG.md: an entry under a new "Unreleased" section.

Checked locally.

The HELP reply names the library and its exact version to any client,
and nothing could change it. ServerBuilder::help_text sets the lines of
the 214 reply instead; without it, the reply is unchanged.

Closes Cloudinvoke#608
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow customizing (or hiding) the HELP response: it discloses the library name and version

1 participant