Cached public methods (CachedPublic)¶

Type	Scope	Severity	Activated by default	Minutes to fix	Tags
`Code smell`	`BSL`	`Major`	`Yes`	`5`	`standard` `design`

Description¶

You should not create a programming interface in modules that reuse return values.

3.6. Another example of hiding library implementation details from a consumer. Suppose: in the first version of the library, consumers were provided with an export function of a common module with repeated use of return values; But in the next version of the library, this design decision was revised in favor of the “usual” general module, where this function was transferred (similarly, if in the opposite direction). In this example, in order to save the library user from additional efforts to replace calls of the "old" function with a new one, it is recommended to immediately place the export function in the "regular" module, in its section "program interface". Then this function, depending on the current design decision, can call the utility function from the module with repeated use of the returned values or from any other module, or directly contain the implementation. However, for the consumer, its location will no longer change in future versions of the library.

Examples¶

Sources¶

Source: Standard: Ensuring Library Compatibility (RU)

Snippets¶

Diagnostic ignorance in code¶

// BSLLS:CachedPublic-off
// BSLLS:CachedPublic-on

Parameter for config¶

"CachedPublic": false