Function ExampleContext_LoadModule_array

context_test.go:54–85

()

}

func ExampleContext_LoadModule_array() {
	// this whole first part is just setting up for the example;
	// note the struct tags - very important; we specify inline_key
	// because that is the only way to know the module name
	var ctx Context
	myStruct := &struct {
		// This godoc comment will appear in module documentation.
		GuestModulesRaw []json.RawMessage `json:"guest_modules,omitempty" caddy:"namespace=example inline_key=name"`

		// this is where the decoded module will be stored; in this
		// example, we pretend we need an io.Writer but it can be
		// any interface type that is useful to you
		guestModules []io.Writer
	}{
		GuestModulesRaw: []json.RawMessage{
			json.RawMessage(`{"name":"module1_name","foo":"bar1"}`),
			json.RawMessage(`{"name":"module2_name","foo":"bar2"}`),
		},
	}

	// since our input is []json.RawMessage, the output will be []any
	mods, err := ctx.LoadModule(myStruct, "GuestModulesRaw")
	if err != nil {
		// you'd want to actually handle the error here
		// return fmt.Errorf("loading guest modules: %v", err)
	}
	for _, mod := range mods.([]any) {
		myStruct.guestModules = append(myStruct.guestModules, mod.(io.Writer))
	}

	// use myStruct.guestModules from now on
}

func ExampleContext_LoadModule_map() {
	// this whole first part is just setting up for the example;